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



1119
1120
1121
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1119

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) 


1026
1027
1028
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1026

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) 


1033
1034
1035
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1033

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) 


1039
1040
1041
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1039

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) 


1045
1046
1047
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1045

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) 


1050
1051
1052
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1050

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) 


1063
1064
1065
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1063

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue

Returns:



1068
1069
1070
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1068

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) 


1073
1074
1075
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1073

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



1078
1079
1080
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1078

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) 


1084
1085
1086
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1084

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) 


1090
1091
1092
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1090

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) 


1100
1101
1102
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1100

def original_floodlight_configuration_id
  @original_floodlight_configuration_id
end

#status ⇒ String

Status of this advertiser. Corresponds to the JSON property status

Returns:

  • (String) 


1105
1106
1107
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 1105

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) 


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

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) 


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

def suspended
  @suspended
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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