- [Resource: EventTag](https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags#EventTag)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags#EventTag.SCHEMA_REPRESENTATION)
- [EventTagType](https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags#EventTagType)
- [EventTagSiteFilterType](https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags#EventTagSiteFilterType)
- [EventTagStatus](https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags#EventTagStatus)
- [Methods](https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags#METHODS_SUMMARY)

## Resource: EventTag

Contains properties of an [event tag](https://support.google.com/dcm/answer/6135968).

| JSON representation |
|---|
| ``` { "id": string, "name": string, "accountId": string, "subaccountId": string, "advertiserId": string, "campaignId": string, "type": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags#EventTagType`), "url": string, "siteIds": [ string ], "siteFilterType": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags#EventTagSiteFilterType`), "enabledByDefault": boolean, "status": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags#EventTagStatus`), "urlEscapeLevels": integer, "sslCompliant": boolean, "advertiserIdDimensionValue": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/DimensionValue`) }, "campaignIdDimensionValue": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/DimensionValue`) }, "excludeFromAdxRequests": boolean, "kind": string } ``` |

| Fields ||
|---|---|
| `id` | `string (https://developers.google.com/discovery/v1/type-format 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 (https://developers.google.com/discovery/v1/type-format format)` Account ID of this event tag. This is a read-only field that can be left blank. |
| `subaccountId` | `string (https://developers.google.com/discovery/v1/type-format format)` Subaccount ID of this event tag. This is a read-only field that can be left blank. |
| `advertiserId` | `string (https://developers.google.com/discovery/v1/type-format format)` Advertiser ID of this event tag. This field or the `campaignId` field is required on insertion. |
| `campaignId` | `string (https://developers.google.com/discovery/v1/type-format format)` Campaign ID of this event tag. This field or the `advertiserId` field is required on insertion. |
| `type` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags#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 (https://developers.google.com/discovery/v1/type-format format)` Filter list of site IDs associated with this event tag. The `siteFilterType` determines whether this is a allowlist or blocklist filter. |
| `siteFilterType` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags#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 (`https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags#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 (`https://developers.google.com/doubleclick-advertisers/rest/v5/DimensionValue`)`` Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. |
| `campaignIdDimensionValue` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/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"`. |

## 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 ||
|---|---|
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags/delete` | Deletes an existing event tag. |
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags/get` | Gets one event tag by ID. |
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags/insert` | Inserts a new event tag. |
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags/list` | Retrieves a list of event tags, possibly filtered. |
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags/patch` | Updates an existing event tag. |
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/eventTags/update` | Updates an existing event tag. |