EventTag

import type { EventTag } from "https://googleapis.deno.dev/v1/dfareporting:v4.ts";

Contains properties of an event tag.

interface EventTag {

accountId?: bigint;

advertiserId?: bigint;

advertiserIdDimensionValue?: DimensionValue;

campaignId?: bigint;

campaignIdDimensionValue?: DimensionValue;

enabledByDefault?: boolean;

excludeFromAdxRequests?: boolean;

id?: bigint;

kind?: string;

name?: string;

siteFilterType?: "ALLOWLIST" | "BLOCKLIST";

siteIds?: bigint[];

sslCompliant?: boolean;

status?: "ENABLED" | "DISABLED";

subaccountId?: bigint;

type?: "IMPRESSION_IMAGE_EVENT_TAG" | "IMPRESSION_JAVASCRIPT_EVENT_TAG" | "CLICK_THROUGH_EVENT_TAG";

url?: string;

urlEscapeLevels?: number;

}

§Properties

accountId?: bigint

[src]

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

advertiserId?: bigint

[src]

Advertiser ID of this event tag. This field or the campaignId field is required on insertion.

advertiserIdDimensionValue?: DimensionValue

[src]

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

campaignId?: bigint

[src]

Campaign ID of this event tag. This field or the advertiserId field is required on insertion.

campaignIdDimensionValue?: DimensionValue

[src]

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

enabledByDefault?: boolean

[src]

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

excludeFromAdxRequests?: boolean

[src]

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?: bigint

[src]

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

kind?: string

[src]

Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".

name?: string

[src]

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

siteFilterType?: "ALLOWLIST" | "BLOCKLIST"

[src]

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

siteIds?: bigint[]

[src]

Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a allowlist or blocklist filter.

sslCompliant?: boolean

[src]

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

status?: "ENABLED" | "DISABLED"

[src]

Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.

subaccountId?: bigint

[src]

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

type?: "IMPRESSION_IMAGE_EVENT_TAG" | "IMPRESSION_JAVASCRIPT_EVENT_TAG" | "CLICK_THROUGH_EVENT_TAG"

[src]

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

[src]

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?: number

[src]

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.