EventTagsListOptions

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

Additional options for dfareporting#eventTagsList.

interface EventTagsListOptions {

adId?: bigint;

advertiserId?: bigint;

campaignId?: bigint;

definitionsOnly?: boolean;

enabled?: boolean;

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

ids?: bigint;

searchString?: string;

sortField?: "ID" | "NAME";

sortOrder?: "ASCENDING" | "DESCENDING";

}

§Properties

adId?: bigint

[src]

Select only event tags that belong to this ad.

advertiserId?: bigint

[src]

Select only event tags that belong to this advertiser.

campaignId?: bigint

[src]

Select only event tags that belong to this campaign.

definitionsOnly?: boolean

[src]

Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.

enabled?: boolean

[src]

Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.

eventTagTypes?: "IMPRESSION_IMAGE_EVENT_TAG" | "IMPRESSION_JAVASCRIPT_EVENT_TAG" | "CLICK_THROUGH_EVENT_TAG"

[src]

Select only event tags with the specified event tag types. Event tag types 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.

ids?: bigint

[src]

Select only event tags with these IDs.

searchString?: string

[src]

Allows searching for objects by name or ID. Wildcards () are allowed. For example, "eventtag2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".

sortField?: "ID" | "NAME"

[src]

Field by which to sort the list.

sortOrder?: "ASCENDING" | "DESCENDING"

[src]

Order of sorted results.