Class: Google::Apis::DfareportingV4::Advertiser

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

Overview

Contains properties of a Campaign Manager advertiser.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Advertiser

Returns a new instance of Advertiser.



1089
1090
1091
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1089

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) 


987
988
989
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 987

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) 


994
995
996
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 994

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) 


1000
1001
1002
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1000

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) 


1006
1007
1008
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1006

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) 


1011
1012
1013
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1011

def default_email
  @default_email
end

#eu_political_ads_declaration ⇒ String

Optional. Whether the advertiser plans to serve EU political ads. Corresponds to the JSON property euPoliticalAdsDeclaration

Returns:

  • (String) 


1016
1017
1018
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1016

def eu_political_ads_declaration
  @eu_political_ads_declaration
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) 


1028
1029
1030
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1028

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue

Returns:



1033
1034
1035
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1033

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) 


1038
1039
1040
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1038

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



1043
1044
1045
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1043

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) 


1049
1050
1051
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1049

def kind
  @kind
end

#measurement_partner_link ⇒ Google::Apis::DfareportingV4::MeasurementPartnerAdvertiserLink

Measurement partner advertiser link for tag wrapping. Corresponds to the JSON property measurementPartnerLink

Returns:



1054
1055
1056
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1054

def measurement_partner_link
  @measurement_partner_link
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) 


1060
1061
1062
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1060

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) 


1070
1071
1072
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1070

def original_floodlight_configuration_id
  @original_floodlight_configuration_id
end

#status ⇒ String

Status of this advertiser. Corresponds to the JSON property status

Returns:

  • (String) 


1075
1076
1077
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1075

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) 


1081
1082
1083
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1081

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) 


1086
1087
1088
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1086

def suspended
  @suspended
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1094

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)
  @eu_political_ads_declaration = args[:eu_political_ads_declaration] if args.key?(:eu_political_ads_declaration)
  @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)
  @measurement_partner_link = args[:measurement_partner_link] if args.key?(:measurement_partner_link)
  @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