Class: Google::Apis::DfareportingV3_0::Advertiser

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_0/classes.rb,
generated/google/apis/dfareporting_v3_0/representations.rb,
generated/google/apis/dfareporting_v3_0/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



1167
1168
1169
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1167

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

Instance Attribute Details

#account_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1074
1075
1076
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1074

def 
  @account_id
end

#advertiser_group_id ⇒ Fixnum

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:

  • (Fixnum) 


1081
1082
1083
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1081

def advertiser_group_id
  @advertiser_group_id
end

#click_through_url_suffix ⇒ String

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) 


1087
1088
1089
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1087

def click_through_url_suffix
  @click_through_url_suffix
end

#default_click_through_event_tag_id ⇒ Fixnum

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:

  • (Fixnum) 


1093
1094
1095
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1093

def default_click_through_event_tag_id
  @default_click_through_event_tag_id
end

#default_email ⇒ String

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

Returns:

  • (String) 


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

def default_email
  @default_email
end

#floodlight_configuration_id ⇒ Fixnum

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:

  • (Fixnum) 


1111
1112
1113
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1111

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_value ⇒ Google::Apis::DfareportingV3_0::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue

Returns:



1116
1117
1118
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1116

def floodlight_configuration_id_dimension_value
  @floodlight_configuration_id_dimension_value
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1121
1122
1123
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1121

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_0::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



1126
1127
1128
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1126

def id_dimension_value
  @id_dimension_value
end

#kind ⇒ String

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

Returns:

  • (String) 


1132
1133
1134
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1132

def kind
  @kind
end

#name ⇒ String

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) 


1138
1139
1140
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1138

def name
  @name
end

#original_floodlight_configuration_id ⇒ Fixnum

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:

  • (Fixnum) 


1148
1149
1150
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1148

def original_floodlight_configuration_id
  @original_floodlight_configuration_id
end

#status ⇒ String

Status of this advertiser. Corresponds to the JSON property status

Returns:

  • (String) 


1153
1154
1155
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1153

def status
  @status
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1159
1160
1161
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1159

def subaccount_id
  @subaccount_id
end

#suspended ⇒ Boolean Also known as: suspended?

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

Returns:

  • (Boolean) 


1164
1165
1166
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1164

def suspended
  @suspended
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 1172

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