Resource: EventTag
Contains properties of an event tag.
JSON representation |
---|
{ "id": string, "name": string, "accountId": string, "subaccountId": string, "advertiserId": string, "campaignId": string, "type": enum ( |
Fields | |
---|---|
id |
ID of this event tag. This is a read-only, auto-generated field. |
name |
Name of this event tag. This is a required field and must be less than 256 characters long. |
accountId |
Account ID of this event tag. This is a read-only field that can be left blank. |
subaccountId |
Subaccount ID of this event tag. This is a read-only field that can be left blank. |
advertiserId |
Advertiser ID of this event tag. This field or the
field is required on insertion. |
campaignId |
Campaign ID of this event tag. This field or the
field is required on insertion. |
type |
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. |
url |
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. |
siteIds[] |
Filter list of site IDs associated with this event tag. The
determines whether this is a allowlist or blocklist filter. |
siteFilterType |
Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites. |
enabledByDefault |
Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads. |
status |
Status of this event tag. Must be
for this event tag to fire. This is a required field. |
urlEscapeLevels |
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. |
sslCompliant |
Whether this tag is SSL-compliant or not. This is a read-only field. |
advertiserIdDimensionValue |
Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
campaignIdDimensionValue |
Dimension value for the ID of the campaign. This is a read-only, auto-generated field. |
excludeFromAdxRequests |
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. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
EventTagType
Enums | |
---|---|
IMPRESSION_IMAGE_EVENT_TAG |
A third-party pixel for impression tracking. |
IMPRESSION_JAVASCRIPT_EVENT_TAG |
A third-party JavaScript URL for impression tracking. |
CLICK_THROUGH_EVENT_TAG |
A third-party URL for click tracking that redirects to the landing page. |
EventTagSiteFilterType
Enums | |
---|---|
ALLOWLIST |
The event tag should only ever fire on specified sites. |
BLOCKLIST |
The event tag should fire on all sites EXCEPT the specified sites. |
EventTagStatus
Statuses for whether an event tag should fire as defined or never fire.
Enums | |
---|---|
ENABLED |
|
DISABLED |
Methods |
|
---|---|
|
Deletes an existing event tag. |
|
Gets one event tag by ID. |
|
Inserts a new event tag. |
|
Retrieves a list of event tags, possibly filtered. |
|
Updates an existing event tag. |
|
Updates an existing event tag. |