Class: Google::Apis::DfareportingV3_3::EventTag

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_3/classes.rb,
generated/google/apis/dfareporting_v3_3/representations.rb,
generated/google/apis/dfareporting_v3_3/representations.rb

Overview

Contains properties of an event tag.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EventTag

Returns a new instance of EventTag.



5405
5406
5407
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5405

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

Instance Attribute Details

#account_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5297
5298
5299
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5297

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5303
5304
5305
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5303

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



5308
5309
5310
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5308

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#campaign_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5314
5315
5316
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5314

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



5319
5320
5321
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5319

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#enabled_by_default ⇒ Boolean 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) 


5325
5326
5327
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5325

def enabled_by_default
  @enabled_by_default
end

#exclude_from_adx_requests ⇒ Boolean Also known as: exclude_from_adx_requests?

Whether to remove this event tag from ads that are trafficked through Display & Video 360 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) 


5334
5335
5336
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5334

def exclude_from_adx_requests
  @exclude_from_adx_requests
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5340
5341
5342
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5340

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


5346
5347
5348
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5346

def kind
  @kind
end

#name ⇒ String

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) 


5352
5353
5354
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5352

def name
  @name
end

#site_filter_type ⇒ String

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) 


5358
5359
5360
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5358

def site_filter_type
  @site_filter_type
end

#site_ids ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


5364
5365
5366
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5364

def site_ids
  @site_ids
end

#ssl_compliant ⇒ Boolean 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) 


5369
5370
5371
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5369

def ssl_compliant
  @ssl_compliant
end

#status ⇒ String

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) 


5376
5377
5378
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5376

def status
  @status
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5382
5383
5384
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5382

def subaccount_id
  @subaccount_id
end

#type ⇒ String

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) 


5389
5390
5391
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5389

def type
  @type
end

#url ⇒ String

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) 


5396
5397
5398
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5396

def url
  @url
end

#url_escape_levels ⇒ Fixnum

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) 


5403
5404
5405
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5403

def url_escape_levels
  @url_escape_levels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 5410

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