Class: Google::Apis::DfareportingV2_5::EventTag

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 an event tag.

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) ⇒ EventTag

Returns a new instance of EventTag.


5220
5221
5222
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5220

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_idString

Account ID of this event tag. This is a read-only field that can be left blank. Corresponds to the JSON property accountId

Returns:

  • (String)

5112
5113
5114
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5112

def 
  @account_id
end

#advertiser_idString

Advertiser ID of this event tag. This field or the campaignId field is required on insertion. Corresponds to the JSON property advertiserId

Returns:

  • (String)

5118
5119
5120
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5118

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_valueGoogle::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue


5123
5124
5125
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5123

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#campaign_idString

Campaign ID of this event tag. This field or the advertiserId field is required on insertion. Corresponds to the JSON property campaignId

Returns:

  • (String)

5129
5130
5131
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5129

def campaign_id
  @campaign_id
end

#campaign_id_dimension_valueGoogle::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue


5134
5135
5136
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5134

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#enabled_by_defaultBoolean Also known as: enabled_by_default?

Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. Corresponds to the JSON property enabledByDefault

Returns:

  • (Boolean)

5140
5141
5142
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5140

def enabled_by_default
  @enabled_by_default
end

#exclude_from_adx_requestsBoolean Also known as: exclude_from_adx_requests?

Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network. Corresponds to the JSON property excludeFromAdxRequests

Returns:

  • (Boolean)

5149
5150
5151
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5149

def exclude_from_adx_requests
  @exclude_from_adx_requests
end

#idString

ID of this event tag. This is a read-only, auto-generated field. Corresponds to the JSON property id

Returns:

  • (String)

5155
5156
5157
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5155

def id
  @id
end

#kindString

Identifies what kind of resource this is. Value: the fixed string " dfareporting#eventTag". Corresponds to the JSON property kind

Returns:

  • (String)

5161
5162
5163
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5161

def kind
  @kind
end

#nameString

Name of this event tag. This is a required field and must be less than 256 characters long. Corresponds to the JSON property name

Returns:

  • (String)

5167
5168
5169
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5167

def name
  @name
end

#site_filter_typeString

Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites. Corresponds to the JSON property siteFilterType

Returns:

  • (String)

5173
5174
5175
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5173

def site_filter_type
  @site_filter_type
end

#site_idsArray<String>

Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter. Corresponds to the JSON property siteIds

Returns:

  • (Array<String>)

5179
5180
5181
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5179

def site_ids
  @site_ids
end

#ssl_compliantBoolean Also known as: ssl_compliant?

Whether this tag is SSL-compliant or not. This is a read-only field. Corresponds to the JSON property sslCompliant

Returns:

  • (Boolean)

5184
5185
5186
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5184

def ssl_compliant
  @ssl_compliant
end

#statusString

Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field. Corresponds to the JSON property status

Returns:

  • (String)

5191
5192
5193
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5191

def status
  @status
end

#subaccount_idString

Subaccount ID of this event tag. This is a read-only field that can be left blank. Corresponds to the JSON property subaccountId

Returns:

  • (String)

5197
5198
5199
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5197

def subaccount_id
  @subaccount_id
end

#typeString

Event tag type. Can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. This is a required field. Corresponds to the JSON property type

Returns:

  • (String)

5204
5205
5206
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5204

def type
  @type
end

#urlString

Payload URL for this event tag. The URL on a click-through event tag should have a landing page URL appended to the end of it. This field is required on insertion. Corresponds to the JSON property url

Returns:

  • (String)

5211
5212
5213
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5211

def url
  @url
end

#url_escape_levelsFixnum

Number of times the landing page URL should be URL-escaped before being appended to the click-through event tag URL. Only applies to click-through event tags as specified by the event tag type. Corresponds to the JSON property urlEscapeLevels

Returns:

  • (Fixnum)

5218
5219
5220
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5218

def url_escape_levels
  @url_escape_levels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 5225

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value)
  @campaign_id = args[:campaign_id] if args.key?(:campaign_id)
  @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value)
  @enabled_by_default = args[:enabled_by_default] if args.key?(:enabled_by_default)
  @exclude_from_adx_requests = args[:exclude_from_adx_requests] if args.key?(:exclude_from_adx_requests)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @site_filter_type = args[:site_filter_type] if args.key?(:site_filter_type)
  @site_ids = args[:site_ids] if args.key?(:site_ids)
  @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant)
  @status = args[:status] if args.key?(:status)
  @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id)
  @type = args[:type] if args.key?(:type)
  @url = args[:url] if args.key?(:url)
  @url_escape_levels = args[:url_escape_levels] if args.key?(:url_escape_levels)
end