Class: Google::Apis::DfareportingV2_5::Advertiser

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


1103
1104
1105
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1103

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

Returns:

  • (String)

1010
1011
1012
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1010

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

Returns:

  • (String)

1017
1018
1019
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1017

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

Returns:

  • (String)

1023
1024
1025
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1023

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

Returns:

  • (String)

1029
1030
1031
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1029

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

Returns:

  • (String)

1034
1035
1036
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1034

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

Returns:

  • (String)

1047
1048
1049
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1047

def floodlight_configuration_id
  @floodlight_configuration_id
end

#floodlight_configuration_id_dimension_valueGoogle::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property floodlightConfigurationIdDimensionValue


1052
1053
1054
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1052

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

Returns:

  • (String)

1057
1058
1059
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1057

def id
  @id
end

#id_dimension_valueGoogle::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue


1062
1063
1064
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1062

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

Returns:

  • (String)

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

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

Returns:

  • (String)

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

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

Returns:

  • (String)

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

def original_floodlight_configuration_id
  @original_floodlight_configuration_id
end

#statusString

Status of this advertiser. Corresponds to the JSON property status

Returns:

  • (String)

1089
1090
1091
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1089

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

Returns:

  • (String)

1095
1096
1097
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1095

def subaccount_id
  @subaccount_id
end

#suspendedBoolean Also known as: suspended?

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

Returns:

  • (Boolean)

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

def suspended
  @suspended
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 1108

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