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.



1078
1079
1080
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1078

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) 


981
982
983
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 981

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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:



1022
1023
1024
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1022

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) 


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

def id
  @id
end

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

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



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

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) 


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

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:



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

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) 


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

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) 


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

def original_floodlight_configuration_id
  @original_floodlight_configuration_id
end

#status ⇒ String

Status of this advertiser. Corresponds to the JSON property status

Returns:

  • (String) 


1064
1065
1066
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1064

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) 


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

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) 


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

def suspended
  @suspended
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 1083

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