Publish
|
|||||
|
|
Publishes a Container Version
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Publish your Google Tag Manager container versions
Input
This building block consumes 2 input parameters
Name | Format | Description |
---|---|---|
path Required |
STRING |
GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id} |
fingerprint |
STRING |
When provided, this fingerprint must match the fingerprint of the container version in storage |
= Parameter name
= Format
path STRING Required GTM ContainerVersion's API relative path. Example: accounts/{account_id}/containers/{container_id}/versions/{version_id} |
fingerprint STRING When provided, this fingerprint must match the fingerprint of the container version in storage |
Output
This building block provides 196 output parameters
Name | Format | Description |
---|---|---|
compilerError |
BOOLEAN |
Compiler errors or not |
containerVersion |
OBJECT |
Represents a Google Tag Manager Container Version |
containerVersion.accountId |
STRING |
GTM Account ID |
containerVersion.builtInVariable[] |
OBJECT |
Built-in variables are a special category of variables that are pre-created and non-customizable. They provide common functionality like accessing propeties of the gtm data layer, monitoring clicks, or accessing elements of a page URL |
containerVersion.builtInVariable[].accountId |
STRING |
GTM Account ID |
containerVersion.builtInVariable[].containerId |
STRING |
GTM Container ID |
containerVersion.builtInVariable[].name |
STRING |
Name of the built-in variable to be used to refer to the built-in variable |
containerVersion.builtInVariable[].path |
STRING |
GTM BuiltInVariable's API relative path |
containerVersion.builtInVariable[].type |
ENUMERATION |
Type of built-in variable |
containerVersion.builtInVariable[].workspaceId |
STRING |
GTM Workspace ID |
containerVersion.container |
OBJECT |
Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions |
containerVersion.container.accountId |
STRING |
GTM Account ID |
containerVersion.container.containerId |
STRING |
The Container ID uniquely identifies the GTM Container |
containerVersion.container.domainName[] |
STRING |
|
containerVersion.container.fingerprint |
STRING |
The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified |
containerVersion.container.name |
STRING |
Container display name |
containerVersion.container.notes |
STRING |
Container Notes |
containerVersion.container.path |
STRING |
GTM Container's API relative path |
containerVersion.container.publicId |
STRING |
Container Public ID |
containerVersion.container.tagManagerUrl |
STRING |
Auto generated link to the tag manager UI |
containerVersion.container.usageContext[] |
ENUMERATION |
|
containerVersion.containerId |
STRING |
GTM Container ID |
containerVersion.containerVersionId |
STRING |
The Container Version ID uniquely identifies the GTM Container Version |
containerVersion.customTemplate[] |
OBJECT |
Represents a Google Tag Manager Custom Template's contents |
containerVersion.customTemplate[].accountId |
STRING |
GTM Account ID |
containerVersion.customTemplate[].containerId |
STRING |
GTM Container ID |
containerVersion.customTemplate[].fingerprint |
STRING |
The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified |
containerVersion.customTemplate[].name |
STRING |
Custom Template display name |
containerVersion.customTemplate[].path |
STRING |
GTM Custom Template's API relative path |
containerVersion.customTemplate[].tagManagerUrl |
STRING |
Auto generated link to the tag manager UI |
containerVersion.customTemplate[].templateData |
STRING |
The custom template in text format |
containerVersion.customTemplate[].templateId |
STRING |
The Custom Template ID uniquely identifies the GTM custom template |
containerVersion.customTemplate[].workspaceId |
STRING |
GTM Workspace ID |
containerVersion.deleted |
BOOLEAN |
A value of true indicates this container version has been deleted |
containerVersion.description |
STRING |
Container version description |
containerVersion.fingerprint |
STRING |
The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified |
containerVersion.folder[] |
OBJECT |
Represents a Google Tag Manager Folder |
containerVersion.folder[].accountId |
STRING |
GTM Account ID |
containerVersion.folder[].containerId |
STRING |
GTM Container ID |
containerVersion.folder[].fingerprint |
STRING |
The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified |
containerVersion.folder[].folderId |
STRING |
The Folder ID uniquely identifies the GTM Folder |
containerVersion.folder[].name |
STRING |
Folder display name |
containerVersion.folder[].notes |
STRING |
User notes on how to apply this folder in the container |
containerVersion.folder[].path |
STRING |
GTM Folder's API relative path |
containerVersion.folder[].tagManagerUrl |
STRING |
Auto generated link to the tag manager UI |
containerVersion.folder[].workspaceId |
STRING |
GTM Workspace ID |
containerVersion.name |
STRING |
Container version display name |
containerVersion.path |
STRING |
GTM ContainerVersions's API relative path |
containerVersion.tag[] |
OBJECT |
Represents a Google Tag Manager Tag |
containerVersion.tag[].accountId |
STRING |
GTM Account ID |
containerVersion.tag[].blockingRuleId[] |
STRING |
|
containerVersion.tag[].blockingTriggerId[] |
STRING |
|
containerVersion.tag[].containerId |
STRING |
GTM Container ID |
containerVersion.tag[].fingerprint |
STRING |
The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified |
containerVersion.tag[].firingRuleId[] |
STRING |
|
containerVersion.tag[].firingTriggerId[] |
STRING |
|
containerVersion.tag[].liveOnly |
BOOLEAN |
If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode) |
containerVersion.tag[].name |
STRING |
Tag display name |
containerVersion.tag[].notes |
STRING |
User notes on how to apply this tag in the container |
containerVersion.tag[].parameter[] |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.tag[].parentFolderId |
STRING |
Parent folder id |
containerVersion.tag[].path |
STRING |
GTM Tag's API relative path |
containerVersion.tag[].paused |
BOOLEAN |
Indicates whether the tag is paused, which prevents the tag from firing |
containerVersion.tag[].priority |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.tag[].priority.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.tag[].priority.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.tag[].priority.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.tag[].scheduleEndMs |
INTEGER |
The end timestamp in milliseconds to schedule a tag |
containerVersion.tag[].scheduleStartMs |
INTEGER |
The start timestamp in milliseconds to schedule a tag |
containerVersion.tag[].setupTag[] |
OBJECT |
Represents a reference to atag that fires before another tag in order to set up dependencies |
containerVersion.tag[].tagFiringOption |
ENUMERATION |
Option to fire this tag |
containerVersion.tag[].tagId |
STRING |
The Tag ID uniquely identifies the GTM Tag |
containerVersion.tag[].tagManagerUrl |
STRING |
Auto generated link to the tag manager UI |
containerVersion.tag[].teardownTag[] |
OBJECT |
Represents a tag that fires after another tag in order to tear down dependencies |
containerVersion.tag[].type |
STRING |
GTM Tag Type |
containerVersion.tag[].workspaceId |
STRING |
GTM Workspace ID |
containerVersion.tagManagerUrl |
STRING |
Auto generated link to the tag manager UI |
containerVersion.trigger[] |
OBJECT |
Represents a Google Tag Manager Trigger |
containerVersion.trigger[].accountId |
STRING |
GTM Account ID |
containerVersion.trigger[].autoEventFilter[] |
OBJECT |
Represents a predicate |
containerVersion.trigger[].checkValidation |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].checkValidation.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].checkValidation.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].checkValidation.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].containerId |
STRING |
GTM Container ID |
containerVersion.trigger[].continuousTimeMinMilliseconds |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].continuousTimeMinMilliseconds.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].continuousTimeMinMilliseconds.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].continuousTimeMinMilliseconds.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].customEventFilter[] |
OBJECT |
Represents a predicate |
containerVersion.trigger[].eventName |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].eventName.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].eventName.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].eventName.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].filter[] |
OBJECT |
Represents a predicate |
containerVersion.trigger[].fingerprint |
STRING |
The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified |
containerVersion.trigger[].horizontalScrollPercentageList |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].horizontalScrollPercentageList.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].horizontalScrollPercentageList.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].horizontalScrollPercentageList.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].interval |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].interval.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].interval.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].interval.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].intervalSeconds |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].intervalSeconds.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].intervalSeconds.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].intervalSeconds.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].limit |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].limit.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].limit.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].limit.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].maxTimerLengthSeconds |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].maxTimerLengthSeconds.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].maxTimerLengthSeconds.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].maxTimerLengthSeconds.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].name |
STRING |
Trigger display name |
containerVersion.trigger[].notes |
STRING |
User notes on how to apply this trigger in the container |
containerVersion.trigger[].parameter[] |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].parentFolderId |
STRING |
Parent folder id |
containerVersion.trigger[].path |
STRING |
GTM Trigger's API relative path |
containerVersion.trigger[].selector |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].selector.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].selector.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].selector.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].tagManagerUrl |
STRING |
Auto generated link to the tag manager UI |
containerVersion.trigger[].totalTimeMinMilliseconds |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].totalTimeMinMilliseconds.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].totalTimeMinMilliseconds.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].totalTimeMinMilliseconds.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].triggerId |
STRING |
The Trigger ID uniquely identifies the GTM Trigger |
containerVersion.trigger[].type |
ENUMERATION |
Defines the data layer event that causes this trigger |
containerVersion.trigger[].uniqueTriggerId |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].uniqueTriggerId.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].uniqueTriggerId.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].uniqueTriggerId.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].verticalScrollPercentageList |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].verticalScrollPercentageList.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].verticalScrollPercentageList.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].verticalScrollPercentageList.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].visibilitySelector |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].visibilitySelector.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].visibilitySelector.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].visibilitySelector.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].visiblePercentageMax |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].visiblePercentageMax.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].visiblePercentageMax.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].visiblePercentageMax.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].visiblePercentageMin |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].visiblePercentageMin.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].visiblePercentageMin.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].visiblePercentageMin.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].waitForTags |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].waitForTags.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].waitForTags.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].waitForTags.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].waitForTagsTimeout |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.trigger[].waitForTagsTimeout.key |
STRING |
The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].waitForTagsTimeout.type |
ENUMERATION |
The parameter type. Valid values are:
|
containerVersion.trigger[].waitForTagsTimeout.value |
STRING |
A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].workspaceId |
STRING |
GTM Workspace ID |
containerVersion.variable[] |
OBJECT |
Represents a Google Tag Manager Variable |
containerVersion.variable[].accountId |
STRING |
GTM Account ID |
containerVersion.variable[].containerId |
STRING |
GTM Container ID |
containerVersion.variable[].disablingTriggerId[] |
STRING |
|
containerVersion.variable[].enablingTriggerId[] |
STRING |
|
containerVersion.variable[].fingerprint |
STRING |
The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified |
containerVersion.variable[].formatValue |
OBJECT |
|
containerVersion.variable[].formatValue.caseConversionType |
ENUMERATION |
The option to convert a string-type variable value to either lowercase or uppercase |
containerVersion.variable[].name |
STRING |
Variable display name |
containerVersion.variable[].notes |
STRING |
User notes on how to apply this variable in the container |
containerVersion.variable[].parameter[] |
OBJECT |
Represents a Google Tag Manager Parameter |
containerVersion.variable[].parentFolderId |
STRING |
Parent folder id |
containerVersion.variable[].path |
STRING |
GTM Variable's API relative path |
containerVersion.variable[].scheduleEndMs |
INTEGER |
The end timestamp in milliseconds to schedule a variable |
containerVersion.variable[].scheduleStartMs |
INTEGER |
The start timestamp in milliseconds to schedule a variable |
containerVersion.variable[].tagManagerUrl |
STRING |
Auto generated link to the tag manager UI |
containerVersion.variable[].type |
STRING |
GTM Variable Type |
containerVersion.variable[].variableId |
STRING |
The Variable ID uniquely identifies the GTM Variable |
containerVersion.variable[].workspaceId |
STRING |
GTM Workspace ID |
containerVersion.zone[] |
OBJECT |
Represents a Google Tag Manager Zone's contents |
containerVersion.zone[].accountId |
STRING |
GTM Account ID |
containerVersion.zone[].boundary |
OBJECT |
Represents a Zone's boundaries |
containerVersion.zone[].boundary.customEvaluationTriggerId[] |
STRING |
|
containerVersion.zone[].childContainer[] |
OBJECT |
Represents a child container of a Zone |
containerVersion.zone[].containerId |
STRING |
GTM Container ID |
containerVersion.zone[].fingerprint |
STRING |
The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified |
containerVersion.zone[].name |
STRING |
Zone display name |
containerVersion.zone[].notes |
STRING |
User notes on how to apply this zone in the container |
containerVersion.zone[].path |
STRING |
GTM Zone's API relative path |
containerVersion.zone[].tagManagerUrl |
STRING |
Auto generated link to the tag manager UI |
containerVersion.zone[].typeRestriction |
OBJECT |
Represents a Zone's type restrictions |
containerVersion.zone[].typeRestriction.enable |
BOOLEAN |
True if type restrictions have been enabled for this Zone |
containerVersion.zone[].typeRestriction.whitelistedTypeId[] |
STRING |
|
containerVersion.zone[].workspaceId |
STRING |
GTM Workspace ID |
containerVersion.zone[].zoneId |
STRING |
The Zone ID uniquely identifies the GTM Zone |
= Parameter name
= Format
compilerError BOOLEAN Compiler errors or not |
containerVersion OBJECT Represents a Google Tag Manager Container Version |
containerVersion.accountId STRING GTM Account ID |
containerVersion.builtInVariable[] OBJECT Built-in variables are a special category of variables that are pre-created and non-customizable. They provide common functionality like accessing propeties of the gtm data layer, monitoring clicks, or accessing elements of a page URL |
containerVersion.builtInVariable[].accountId STRING GTM Account ID |
containerVersion.builtInVariable[].containerId STRING GTM Container ID |
containerVersion.builtInVariable[].name STRING Name of the built-in variable to be used to refer to the built-in variable |
containerVersion.builtInVariable[].path STRING GTM BuiltInVariable's API relative path |
containerVersion.builtInVariable[].type ENUMERATION Type of built-in variable |
containerVersion.builtInVariable[].workspaceId STRING GTM Workspace ID |
containerVersion.container OBJECT Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions |
containerVersion.container.accountId STRING GTM Account ID |
containerVersion.container.containerId STRING The Container ID uniquely identifies the GTM Container |
containerVersion.container.domainName[] STRING |
containerVersion.container.fingerprint STRING The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified |
containerVersion.container.name STRING Container display name |
containerVersion.container.notes STRING Container Notes |
containerVersion.container.path STRING GTM Container's API relative path |
containerVersion.container.publicId STRING Container Public ID |
containerVersion.container.tagManagerUrl STRING Auto generated link to the tag manager UI |
containerVersion.container.usageContext[] ENUMERATION |
containerVersion.containerId STRING GTM Container ID |
containerVersion.containerVersionId STRING The Container Version ID uniquely identifies the GTM Container Version |
containerVersion.customTemplate[] OBJECT Represents a Google Tag Manager Custom Template's contents |
containerVersion.customTemplate[].accountId STRING GTM Account ID |
containerVersion.customTemplate[].containerId STRING GTM Container ID |
containerVersion.customTemplate[].fingerprint STRING The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified |
containerVersion.customTemplate[].name STRING Custom Template display name |
containerVersion.customTemplate[].path STRING GTM Custom Template's API relative path |
containerVersion.customTemplate[].tagManagerUrl STRING Auto generated link to the tag manager UI |
containerVersion.customTemplate[].templateData STRING The custom template in text format |
containerVersion.customTemplate[].templateId STRING The Custom Template ID uniquely identifies the GTM custom template |
containerVersion.customTemplate[].workspaceId STRING GTM Workspace ID |
containerVersion.deleted BOOLEAN A value of true indicates this container version has been deleted |
containerVersion.description STRING Container version description |
containerVersion.fingerprint STRING The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified |
containerVersion.folder[] OBJECT Represents a Google Tag Manager Folder |
containerVersion.folder[].accountId STRING GTM Account ID |
containerVersion.folder[].containerId STRING GTM Container ID |
containerVersion.folder[].fingerprint STRING The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified |
containerVersion.folder[].folderId STRING The Folder ID uniquely identifies the GTM Folder |
containerVersion.folder[].name STRING Folder display name |
containerVersion.folder[].notes STRING User notes on how to apply this folder in the container |
containerVersion.folder[].path STRING GTM Folder's API relative path |
containerVersion.folder[].tagManagerUrl STRING Auto generated link to the tag manager UI |
containerVersion.folder[].workspaceId STRING GTM Workspace ID |
containerVersion.name STRING Container version display name |
containerVersion.path STRING GTM ContainerVersions's API relative path |
containerVersion.tag[] OBJECT Represents a Google Tag Manager Tag |
containerVersion.tag[].accountId STRING GTM Account ID |
containerVersion.tag[].blockingRuleId[] STRING |
containerVersion.tag[].blockingTriggerId[] STRING |
containerVersion.tag[].containerId STRING GTM Container ID |
containerVersion.tag[].fingerprint STRING The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified |
containerVersion.tag[].firingRuleId[] STRING |
containerVersion.tag[].firingTriggerId[] STRING |
containerVersion.tag[].liveOnly BOOLEAN If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode) |
containerVersion.tag[].name STRING Tag display name |
containerVersion.tag[].notes STRING User notes on how to apply this tag in the container |
containerVersion.tag[].parameter[] OBJECT Represents a Google Tag Manager Parameter |
containerVersion.tag[].parentFolderId STRING Parent folder id |
containerVersion.tag[].path STRING GTM Tag's API relative path |
containerVersion.tag[].paused BOOLEAN Indicates whether the tag is paused, which prevents the tag from firing |
containerVersion.tag[].priority OBJECT Represents a Google Tag Manager Parameter |
containerVersion.tag[].priority.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.tag[].priority.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.tag[].priority.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.tag[].scheduleEndMs INTEGER The end timestamp in milliseconds to schedule a tag |
containerVersion.tag[].scheduleStartMs INTEGER The start timestamp in milliseconds to schedule a tag |
containerVersion.tag[].setupTag[] OBJECT Represents a reference to atag that fires before another tag in order to set up dependencies |
containerVersion.tag[].tagFiringOption ENUMERATION Option to fire this tag |
containerVersion.tag[].tagId STRING The Tag ID uniquely identifies the GTM Tag |
containerVersion.tag[].tagManagerUrl STRING Auto generated link to the tag manager UI |
containerVersion.tag[].teardownTag[] OBJECT Represents a tag that fires after another tag in order to tear down dependencies |
containerVersion.tag[].type STRING GTM Tag Type |
containerVersion.tag[].workspaceId STRING GTM Workspace ID |
containerVersion.tagManagerUrl STRING Auto generated link to the tag manager UI |
containerVersion.trigger[] OBJECT Represents a Google Tag Manager Trigger |
containerVersion.trigger[].accountId STRING GTM Account ID |
containerVersion.trigger[].autoEventFilter[] OBJECT Represents a predicate |
containerVersion.trigger[].checkValidation OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].checkValidation.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].checkValidation.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].checkValidation.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].containerId STRING GTM Container ID |
containerVersion.trigger[].continuousTimeMinMilliseconds OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].continuousTimeMinMilliseconds.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].continuousTimeMinMilliseconds.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].continuousTimeMinMilliseconds.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].customEventFilter[] OBJECT Represents a predicate |
containerVersion.trigger[].eventName OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].eventName.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].eventName.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].eventName.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].filter[] OBJECT Represents a predicate |
containerVersion.trigger[].fingerprint STRING The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified |
containerVersion.trigger[].horizontalScrollPercentageList OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].horizontalScrollPercentageList.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].horizontalScrollPercentageList.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].horizontalScrollPercentageList.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].interval OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].interval.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].interval.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].interval.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].intervalSeconds OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].intervalSeconds.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].intervalSeconds.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].intervalSeconds.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].limit OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].limit.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].limit.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].limit.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].maxTimerLengthSeconds OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].maxTimerLengthSeconds.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].maxTimerLengthSeconds.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].maxTimerLengthSeconds.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].name STRING Trigger display name |
containerVersion.trigger[].notes STRING User notes on how to apply this trigger in the container |
containerVersion.trigger[].parameter[] OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].parentFolderId STRING Parent folder id |
containerVersion.trigger[].path STRING GTM Trigger's API relative path |
containerVersion.trigger[].selector OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].selector.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].selector.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].selector.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].tagManagerUrl STRING Auto generated link to the tag manager UI |
containerVersion.trigger[].totalTimeMinMilliseconds OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].totalTimeMinMilliseconds.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].totalTimeMinMilliseconds.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].totalTimeMinMilliseconds.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].triggerId STRING The Trigger ID uniquely identifies the GTM Trigger |
containerVersion.trigger[].type ENUMERATION Defines the data layer event that causes this trigger |
containerVersion.trigger[].uniqueTriggerId OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].uniqueTriggerId.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].uniqueTriggerId.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].uniqueTriggerId.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].verticalScrollPercentageList OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].verticalScrollPercentageList.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].verticalScrollPercentageList.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].verticalScrollPercentageList.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].visibilitySelector OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].visibilitySelector.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].visibilitySelector.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].visibilitySelector.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].visiblePercentageMax OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].visiblePercentageMax.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].visiblePercentageMax.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].visiblePercentageMax.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].visiblePercentageMin OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].visiblePercentageMin.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].visiblePercentageMin.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].visiblePercentageMin.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].waitForTags OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].waitForTags.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].waitForTags.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].waitForTags.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].waitForTagsTimeout OBJECT Represents a Google Tag Manager Parameter |
containerVersion.trigger[].waitForTagsTimeout.key STRING The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values |
containerVersion.trigger[].waitForTagsTimeout.type ENUMERATION The parameter type. Valid values are:
|
containerVersion.trigger[].waitForTagsTimeout.value STRING A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type |
containerVersion.trigger[].workspaceId STRING GTM Workspace ID |
containerVersion.variable[] OBJECT Represents a Google Tag Manager Variable |
containerVersion.variable[].accountId STRING GTM Account ID |
containerVersion.variable[].containerId STRING GTM Container ID |
containerVersion.variable[].disablingTriggerId[] STRING |
containerVersion.variable[].enablingTriggerId[] STRING |
containerVersion.variable[].fingerprint STRING The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified |
containerVersion.variable[].formatValue OBJECT |
containerVersion.variable[].formatValue.caseConversionType ENUMERATION The option to convert a string-type variable value to either lowercase or uppercase |
containerVersion.variable[].name STRING Variable display name |
containerVersion.variable[].notes STRING User notes on how to apply this variable in the container |
containerVersion.variable[].parameter[] OBJECT Represents a Google Tag Manager Parameter |
containerVersion.variable[].parentFolderId STRING Parent folder id |
containerVersion.variable[].path STRING GTM Variable's API relative path |
containerVersion.variable[].scheduleEndMs INTEGER The end timestamp in milliseconds to schedule a variable |
containerVersion.variable[].scheduleStartMs INTEGER The start timestamp in milliseconds to schedule a variable |
containerVersion.variable[].tagManagerUrl STRING Auto generated link to the tag manager UI |
containerVersion.variable[].type STRING GTM Variable Type |
containerVersion.variable[].variableId STRING The Variable ID uniquely identifies the GTM Variable |
containerVersion.variable[].workspaceId STRING GTM Workspace ID |
containerVersion.zone[] OBJECT Represents a Google Tag Manager Zone's contents |
containerVersion.zone[].accountId STRING GTM Account ID |
containerVersion.zone[].boundary OBJECT Represents a Zone's boundaries |
containerVersion.zone[].boundary.customEvaluationTriggerId[] STRING |
containerVersion.zone[].childContainer[] OBJECT Represents a child container of a Zone |
containerVersion.zone[].containerId STRING GTM Container ID |
containerVersion.zone[].fingerprint STRING The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified |
containerVersion.zone[].name STRING Zone display name |
containerVersion.zone[].notes STRING User notes on how to apply this zone in the container |
containerVersion.zone[].path STRING GTM Zone's API relative path |
containerVersion.zone[].tagManagerUrl STRING Auto generated link to the tag manager UI |
containerVersion.zone[].typeRestriction OBJECT Represents a Zone's type restrictions |
containerVersion.zone[].typeRestriction.enable BOOLEAN True if type restrictions have been enabled for this Zone |
containerVersion.zone[].typeRestriction.whitelistedTypeId[] STRING |
containerVersion.zone[].workspaceId STRING GTM Workspace ID |
containerVersion.zone[].zoneId STRING The Zone ID uniquely identifies the GTM Zone |