class Google::Apis::DfareportingV3_5::EventTag

Contains properties of an event tag.

Attributes

account_id[RW]

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

advertiser_id[RW]

Advertiser ID of this event tag. This field or the campaignId field is required on insertion. Corresponds to the JSON property `advertiserId` @return [Fixnum]

advertiser_id_dimension_value[RW]

Represents a DimensionValue resource. Corresponds to the JSON property `advertiserIdDimensionValue` @return [Google::Apis::DfareportingV3_5::DimensionValue]

campaign_id[RW]

Campaign ID of this event tag. This field or the advertiserId field is required on insertion. Corresponds to the JSON property `campaignId` @return [Fixnum]

campaign_id_dimension_value[RW]

Represents a DimensionValue resource. Corresponds to the JSON property `campaignIdDimensionValue` @return [Google::Apis::DfareportingV3_5::DimensionValue]

enabled_by_default[RW]

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

enabled_by_default?[RW]

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

exclude_from_adx_requests[RW]

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` @return [Boolean]

exclude_from_adx_requests?[RW]

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` @return [Boolean]

id[RW]

ID of this event tag. This is a read-only, auto-generated field. Corresponds to the JSON property `id` @return [Fixnum]

kind[RW]

Identifies what kind of resource this is. Value: the fixed string “ dfareporting#eventTag”. Corresponds to the JSON property `kind` @return [String]

name[RW]

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

site_filter_type[RW]

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` @return [String]

site_ids[RW]

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` @return [Array<Fixnum>]

ssl_compliant[RW]

Whether this tag is SSL-compliant or not. This is a read-only field. Corresponds to the JSON property `sslCompliant` @return [Boolean]

ssl_compliant?[RW]

Whether this tag is SSL-compliant or not. This is a read-only field. Corresponds to the JSON property `sslCompliant` @return [Boolean]

status[RW]

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` @return [String]

subaccount_id[RW]

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

type[RW]

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` @return [String]

url[RW]

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` @return [String]

url_escape_levels[RW]

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` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/dfareporting_v3_5/classes.rb, line 5566
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/dfareporting_v3_5/classes.rb, line 5571
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