Class: Google::Apis::DfareportingV3_2::EventTag
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_2::EventTag
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v3_2/classes.rb,
generated/google/apis/dfareporting_v3_2/representations.rb,
generated/google/apis/dfareporting_v3_2/representations.rb
Overview
Contains properties of an event tag.
Instance Attribute Summary collapse
-
#account_id ⇒ Fixnum
Account ID of this event tag.
-
#advertiser_id ⇒ Fixnum
Advertiser ID of this event tag.
-
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue
Represents a DimensionValue resource.
-
#campaign_id ⇒ Fixnum
Campaign ID of this event tag.
-
#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue
Represents a DimensionValue resource.
-
#enabled_by_default ⇒ Boolean
(also: #enabled_by_default?)
Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
-
#exclude_from_adx_requests ⇒ Boolean
(also: #exclude_from_adx_requests?)
Whether to remove this event tag from ads that are trafficked through Display & Video 360 to Ad Exchange.
-
#id ⇒ Fixnum
ID of this event tag.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#name ⇒ String
Name of this event tag.
-
#site_filter_type ⇒ String
Site filter type for this event tag.
-
#site_ids ⇒ Array<Fixnum>
Filter list of site IDs associated with this event tag.
-
#ssl_compliant ⇒ Boolean
(also: #ssl_compliant?)
Whether this tag is SSL-compliant or not.
-
#status ⇒ String
Status of this event tag.
-
#subaccount_id ⇒ Fixnum
Subaccount ID of this event tag.
-
#type ⇒ String
Event tag type.
-
#url ⇒ String
Payload URL for this event tag.
-
#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.
Instance Method Summary collapse
-
#initialize(**args) ⇒ EventTag
constructor
A new instance of EventTag.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ EventTag
Returns a new instance of EventTag
5694 5695 5696 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5694 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
5586 5587 5588 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5586 def account_id @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
5592 5593 5594 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5592 def advertiser_id @advertiser_id end |
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property advertiserIdDimensionValue
5597 5598 5599 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5597 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
5603 5604 5605 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5603 def campaign_id @campaign_id end |
#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property campaignIdDimensionValue
5608 5609 5610 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5608 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
5614 5615 5616 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5614 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
5623 5624 5625 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5623 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
5629 5630 5631 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5629 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
5635 5636 5637 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5635 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
5641 5642 5643 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5641 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
5647 5648 5649 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5647 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 whitelist or blacklist filter.
Corresponds to the JSON property siteIds
5653 5654 5655 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5653 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
5658 5659 5660 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5658 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
5665 5666 5667 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5665 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
5671 5672 5673 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5671 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
5678 5679 5680 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5678 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
5685 5686 5687 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5685 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
5692 5693 5694 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5692 def url_escape_levels @url_escape_levels end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 |
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 5699 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 |