Class: Google::Apis::DfareportingV3_4::EventTag
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_4::EventTag
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v3_4/classes.rb,
generated/google/apis/dfareporting_v3_4/representations.rb,
generated/google/apis/dfareporting_v3_4/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_4::DimensionValue
Represents a DimensionValue resource.
-
#campaign_id ⇒ Fixnum
Campaign ID of this event tag.
-
#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::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.
5944 5945 5946 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5944 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
5836 5837 5838 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5836 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
5842 5843 5844 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5842 def advertiser_id @advertiser_id end |
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property advertiserIdDimensionValue
5847 5848 5849 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5847 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
5853 5854 5855 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5853 def campaign_id @campaign_id end |
#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property campaignIdDimensionValue
5858 5859 5860 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5858 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
5864 5865 5866 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5864 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
5873 5874 5875 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5873 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
5879 5880 5881 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5879 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
5885 5886 5887 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5885 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
5891 5892 5893 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5891 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
5897 5898 5899 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5897 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
5903 5904 5905 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5903 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
5908 5909 5910 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5908 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
5915 5916 5917 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5915 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
5921 5922 5923 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5921 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
5928 5929 5930 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5928 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
5935 5936 5937 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5935 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
5942 5943 5944 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5942 def url_escape_levels @url_escape_levels end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 5949 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 |