Class: Google::Apis::DfareportingV2_3::Advertiser

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


1099
1100
1101
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1099

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


1006
1007
1008
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1006

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


1013
1014
1015
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1013

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


1019
1020
1021
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1019

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


1025
1026
1027
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1025

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


1030
1031
1032
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1030

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

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

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_valueGoogle::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue


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

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


1053
1054
1055
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1053

def id
  @id
end

#id_dimension_valueGoogle::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue


1058
1059
1060
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1058

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


1064
1065
1066
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1064

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


1070
1071
1072
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1070

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


1080
1081
1082
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1080

def original_floodlight_configuration_id
  @original_floodlight_configuration_id
end

#statusString

Status of this advertiser. Corresponds to the JSON property status


1085
1086
1087
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1085

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


1091
1092
1093
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1091

def subaccount_id
  @subaccount_id
end

#suspendedBoolean Also known as: suspended?

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


1096
1097
1098
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1096

def suspended
  @suspended
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1104

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