EventTags

For a list of methods for this resource, see the end of this page.

Resource representations

Contains properties of an event tag.

{
  "kind": "dfareporting#eventTag",
  "id": long,
  "name": string,
  "accountId": long,
  "subaccountId": long,
  "advertiserId": long,
  "advertiserIdDimensionValue": dimensionValues Resource,
  "campaignId": long,
  "campaignIdDimensionValue": dimensionValues Resource,
  "type": string,
  "url": string,
  "siteIds": [
    long
  ],
  "siteFilterType": string,
  "enabledByDefault": boolean,
  "status": string,
  "urlEscapeLevels": integer,
  "sslCompliant": boolean,
  "excludeFromAdxRequests": boolean
}

Property name	Value	Description
`accountId`	`long`	Account ID of this event tag. This is a read-only field that can be left blank.
`advertiserId`	`long`	Advertiser ID of this event tag. This field or the `campaignId` field is required on insertion.
`advertiserIdDimensionValue`	`nested object`	Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
`campaignId`	`long`	Campaign ID of this event tag. This field or the `advertiserId` field is required on insertion.
`campaignIdDimensionValue`	`nested object`	Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
`enabledByDefault`	`boolean`	Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
`excludeFromAdxRequests`	`boolean`	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.
`id`	`long`	ID of this event tag. This is a read-only, auto-generated field.
`kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dfareporting#eventTag"`.
`name`	`string`	Name of this event tag. This is a required field and must be less than 256 characters long.
`siteFilterType`	`string`	Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites. Acceptable values are: "`BLACKLIST`" "`WHITELIST`"
`siteIds[]`	`list`	Filter list of site IDs associated with this event tag. The `siteFilterType` determines whether this is a whitelist or blacklist filter.
`sslCompliant`	`boolean`	Whether this tag is SSL-compliant or not. This is a read-only field.
`status`	`string`	Status of this event tag. Must be `ENABLED` for this event tag to fire. This is a required field. Acceptable values are: "`DISABLED`" "`ENABLED`"
`subaccountId`	`long`	Subaccount ID of this event tag. This is a read-only field that can be left blank.
`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. Acceptable values are: "`CLICK_THROUGH_EVENT_TAG`" "`IMPRESSION_IMAGE_EVENT_TAG`" "`IMPRESSION_JAVASCRIPT_EVENT_TAG`"
`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.
`urlEscapeLevels`	`integer`	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.

Methods

delete: Deletes an existing event tag.
get: Gets one event tag by ID.
insert: Inserts a new event tag.
list: Retrieves a list of event tags, possibly filtered.
patch: Updates an existing event tag. This method supports patch semantics.
update: Updates an existing event tag.