REST Resource: eventTags

  • An EventTag resource contains properties of an event tag.

  • Event tags have various properties including ID, name, account ID, advertiser ID, campaign ID, type, URL, and status.

  • Event tags can be filtered by site IDs and site filter type.

  • You can manage event tags using methods like delete, get, insert, list, patch, and update.

Resource: EventTag

Contains properties of an event tag.

JSON representation 
{
  "id": string,
  "name": string,
  "accountId": string,
  "subaccountId": string,
  "advertiserId": string,
  "campaignId": string,
  "type": enum (EventTagType),
  "url": string,
  "siteIds": [
    string
  ],
  "siteFilterType": enum (EventTagSiteFilterType),
  "enabledByDefault": boolean,
  "status": enum (EventTagStatus),
  "urlEscapeLevels": integer,
  "sslCompliant": boolean,
  "advertiserIdDimensionValue": {
    object (DimensionValue)
  },
  "campaignIdDimensionValue": {
    object (DimensionValue)
  },
  "excludeFromAdxRequests": boolean,
  "kind": string
}
Fields
id

string (int64 format)

ID of this event tag. This is a read-only, auto-generated field.
name

string

Name of this event tag. This is a required field and must be less than 256 characters long.
accountId

string (int64 format)

Account ID of this event tag. This is a read-only field that can be left blank.
subaccountId

string (int64 format)

Subaccount ID of this event tag. This is a read-only field that can be left blank.
advertiserId

string (int64 format)

Advertiser ID of this event tag. This field or the

campaignId

field is required on insertion.
campaignId

string (int64 format)

Campaign ID of this event tag. This field or the

advertiserId

field is required on insertion.
type

enum (EventTagType)

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

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.
siteIds[]

string (int64 format)

Filter list of site IDs associated with this event tag. The

siteFilterType

determines whether this is a allowlist or blocklist filter.
siteFilterType

enum (EventTagSiteFilterType)

Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
enabledByDefault

boolean

Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
status

enum (EventTagStatus)

Status of this event tag. Must be

ENABLED

for this event tag to fire. This is a required field.
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.
sslCompliant

boolean

Whether this tag is SSL-compliant or not. This is a read-only field.
advertiserIdDimensionValue

object (DimensionValue)

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
campaignIdDimensionValue

object (DimensionValue)

Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
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.
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#eventTag"

.

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.

update

 Updates an existing event tag.