Class: Google::Apis::DfareportingV2_1::EventTag

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

Overview

Contains properties of an event tag.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ EventTag


4772
4773
4774
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4772

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


4673
4674
4675
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4673

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


4679
4680
4681
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4679

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_valueGoogle::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue


4684
4685
4686
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4684

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


4690
4691
4692
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4690

def campaign_id
  @campaign_id
end

#campaign_id_dimension_valueGoogle::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue


4695
4696
4697
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4695

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


4701
4702
4703
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4701

def enabled_by_default
  @enabled_by_default
end

#idString

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


4707
4708
4709
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4707

def id
  @id
end

#kindString

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


4713
4714
4715
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4713

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


4719
4720
4721
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4719

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


4725
4726
4727
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4725

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


4731
4732
4733
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4731

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


4736
4737
4738
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4736

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


4743
4744
4745
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4743

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


4749
4750
4751
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4749

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


4756
4757
4758
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4756

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


4763
4764
4765
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4763

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


4770
4771
4772
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4770

def url_escape_levels
  @url_escape_levels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4777

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