Class: Google::Apis::DfareportingV2_6::Advertiser

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_6/classes.rb,
generated/google/apis/dfareporting_v2_6/representations.rb,
generated/google/apis/dfareporting_v2_6/representations.rb

Overview

Contains properties of a DCM advertiser.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Advertiser

Returns a new instance of Advertiser.


1117
1118
1119
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1117

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_idString

Account ID of this advertiser.This is a read-only field that can be left blank. Corresponds to the JSON property accountId

Returns:

  • (String)

1024
1025
1026
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1024

def 
  @account_id
end

#advertiser_group_idString

ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group. Corresponds to the JSON property advertiserGroupId

Returns:

  • (String)

1031
1032
1033
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1031

def advertiser_group_id
  @advertiser_group_id
end

#click_through_url_suffixString

Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long. Corresponds to the JSON property clickThroughUrlSuffix

Returns:

  • (String)

1037
1038
1039
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1037

def click_through_url_suffix
  @click_through_url_suffix
end

#default_click_through_event_tag_idString

ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns. Corresponds to the JSON property defaultClickThroughEventTagId

Returns:

  • (String)

1043
1044
1045
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1043

def default_click_through_event_tag_id
  @default_click_through_event_tag_id
end

#default_emailString

Default email address used in sender field for tag emails. Corresponds to the JSON property defaultEmail

Returns:

  • (String)

1048
1049
1050
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1048

def default_email
  @default_email
end

#floodlight_configuration_idString

Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:

  • This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
  • This advertiser's original floodlight configuration is not already shared with another advertiser. Corresponds to the JSON property floodlightConfigurationId

Returns:

  • (String)

1061
1062
1063
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1061

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_valueGoogle::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue


1066
1067
1068
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1066

def floodlight_configuration_id_dimension_value
  @floodlight_configuration_id_dimension_value
end

#idString

ID of this advertiser. This is a read-only, auto-generated field. Corresponds to the JSON property id

Returns:

  • (String)

1071
1072
1073
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1071

def id
  @id
end

#id_dimension_valueGoogle::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue


1076
1077
1078
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1076

def id_dimension_value
  @id_dimension_value
end

#kindString

Identifies what kind of resource this is. Value: the fixed string " dfareporting#advertiser". Corresponds to the JSON property kind

Returns:

  • (String)

1082
1083
1084
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1082

def kind
  @kind
end

#nameString

Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account. Corresponds to the JSON property name

Returns:

  • (String)

1088
1089
1090
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1088

def name
  @name
end

#original_floodlight_configuration_idString

Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement. Corresponds to the JSON property originalFloodlightConfigurationId

Returns:

  • (String)

1098
1099
1100
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1098

def original_floodlight_configuration_id
  @original_floodlight_configuration_id
end

#statusString

Status of this advertiser. Corresponds to the JSON property status

Returns:

  • (String)

1103
1104
1105
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1103

def status
  @status
end

#subaccount_idString

Subaccount ID of this advertiser.This is a read-only field that can be left blank. Corresponds to the JSON property subaccountId

Returns:

  • (String)

1109
1110
1111
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1109

def subaccount_id
  @subaccount_id
end

#suspendedBoolean Also known as: suspended?

Suspension status of this advertiser. Corresponds to the JSON property suspended

Returns:

  • (Boolean)

1114
1115
1116
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1114

def suspended
  @suspended
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1122

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @advertiser_group_id = args[:advertiser_group_id] if args.key?(:advertiser_group_id)
  @click_through_url_suffix = args[:click_through_url_suffix] if args.key?(:click_through_url_suffix)
  @default_click_through_event_tag_id = args[:default_click_through_event_tag_id] if args.key?(:default_click_through_event_tag_id)
  @default_email = args[:default_email] if args.key?(:default_email)
  @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id)
  @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value)
  @id = args[:id] if args.key?(:id)
  @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @original_floodlight_configuration_id = args[:original_floodlight_configuration_id] if args.key?(:original_floodlight_configuration_id)
  @status = args[:status] if args.key?(:status)
  @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id)
  @suspended = args[:suspended] if args.key?(:suspended)
end