Tag

import type { Tag } from "https://googleapis.deno.dev/v1/tagmanager:v2.ts";

Represents a Google Tag Manager Tag.

interface Tag {

accountId?: string;

blockingTriggerId?: string[];

consentSettings?: TagConsentSetting;

containerId?: string;

fingerprint?: string;

firingTriggerId?: string[];

liveOnly?: boolean;

monitoringMetadata?: Parameter;

monitoringMetadataTagNameKey?: string;

name?: string;

notes?: string;

parameter?: Parameter[];

parentFolderId?: string;

path?: string;

paused?: boolean;

priority?: Parameter;

scheduleEndMs?: bigint;

scheduleStartMs?: bigint;

setupTag?: SetupTag[];

tagFiringOption?:

| "tagFiringOptionUnspecified"

| "unlimited"

| "oncePerEvent"

| "oncePerLoad";

tagId?: string;

tagManagerUrl?: string;

teardownTag?: TeardownTag[];

type?: string;

workspaceId?: string;

}

§Properties

accountId?: string

[src]

GTM Account ID.

blockingTriggerId?: string[]

[src]

Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.

consentSettings?: TagConsentSetting

[src]

Consent settings of a tag.

containerId?: string

[src]

GTM Container ID.

fingerprint?: string

[src]

The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.

firingTriggerId?: string[]

[src]

Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.

liveOnly?: boolean

[src]

If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).

monitoringMetadata?: Parameter

[src]

A map of key-value pairs of tag metadata to be included in the event data for tag monitoring. Notes: - This parameter must be type MAP. - Each parameter in the map are type TEMPLATE, however cannot contain variable references.

monitoringMetadataTagNameKey?: string

[src]

If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified.

name?: string

[src]

Tag display name.

notes?: string

[src]

User notes on how to apply this tag in the container.

parameter?: Parameter[]

[src]

The tag's parameters.

parentFolderId?: string

[src]

Parent folder id.

path?: string

[src]

GTM Tag's API relative path.

paused?: boolean

[src]

Indicates whether the tag is paused, which prevents the tag from firing.

priority?: Parameter

[src]

User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.

scheduleEndMs?: bigint

[src]

The end timestamp in milliseconds to schedule a tag.

scheduleStartMs?: bigint

[src]

The start timestamp in milliseconds to schedule a tag.

setupTag?: SetupTag[]

[src]

The list of setup tags. Currently we only allow one.

tagFiringOption?: "tagFiringOptionUnspecified" | "unlimited" | "oncePerEvent" | "oncePerLoad"

[src]

Option to fire this tag.