Versions

For a list of methods for this resource, see the end of this page.

Resource representations

Represents a Google Tag Manager Container Version.

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "containerVersionId": string,
  "name": string,
  "deleted": boolean,
  "description": string,
  "container": accounts.containers Resource,
  "tag": [
    accounts.containers.workspaces.tags Resource
  ],
  "trigger": [
    accounts.containers.workspaces.triggers Resource
  ],
  "variable": [
    accounts.containers.workspaces.variables Resource
  ],
  "folder": [
    accounts.containers.workspaces.folders Resource
  ],
  "builtInVariable": [
    {
      "path": string,
      "accountId": string,
      "containerId": string,
      "workspaceId": string,
      "type": string,
      "name": string
    }
  ],
  "fingerprint": string,
  "tagManagerUrl": string,
  "zone": [
    accounts.containers.workspaces.zones Resource
  ],
  "customTemplate": [
    accounts.containers.workspaces.templates Resource
  ],
  "client": [
    accounts.containers.workspaces.clients Resource
  ],
  "gtagConfig": [
    accounts.containers.workspaces.gtag_config Resource
  ],
  "transformation": [
    accounts.containers.workspaces.transformations Resource
  ]
}
Property name Value Description Notes
accountId string GTM Account ID.
builtInVariable[] list The built-in variables in the container that this version was taken from.
builtInVariable[].accountId string GTM Account ID.
builtInVariable[].containerId string GTM Container ID.
builtInVariable[].name string Name of the built-in variable to be used to refer to the built-in variable.
builtInVariable[].path string GTM BuiltInVariable's API relative path.
builtInVariable[].type string Type of built-in variable.

Acceptable values are:
  • "advertiserId"
  • "advertisingTrackingEnabled"
  • "ampBrowserLanguage"
  • "ampCanonicalHost"
  • "ampCanonicalPath"
  • "ampCanonicalUrl"
  • "ampClientId"
  • "ampClientMaxScrollX"
  • "ampClientMaxScrollY"
  • "ampClientScreenHeight"
  • "ampClientScreenWidth"
  • "ampClientScrollX"
  • "ampClientScrollY"
  • "ampClientTimestamp"
  • "ampClientTimezone"
  • "ampGtmEvent"
  • "ampPageDownloadTime"
  • "ampPageLoadTime"
  • "ampPageViewId"
  • "ampReferrer"
  • "ampTitle"
  • "ampTotalEngagedTime"
  • "appId"
  • "appName"
  • "appVersionCode"
  • "appVersionName"
  • "builtInVariableTypeUnspecified"
  • "clickClasses"
  • "clickElement"
  • "clickId"
  • "clickTarget"
  • "clickText"
  • "clickUrl"
  • "clientName"
  • "containerId"
  • "containerVersion"
  • "debugMode"
  • "deviceName"
  • "elementVisibilityFirstTime"
  • "elementVisibilityRatio"
  • "elementVisibilityRecentTime"
  • "elementVisibilityTime"
  • "environmentName"
  • "errorLine"
  • "errorMessage"
  • "errorUrl"
  • "event"
  • "eventName"
  • "firebaseEventParameterCampaign"
  • "firebaseEventParameterCampaignAclid"
  • "firebaseEventParameterCampaignAnid"
  • "firebaseEventParameterCampaignClickTimestamp"
  • "firebaseEventParameterCampaignContent"
  • "firebaseEventParameterCampaignCp1"
  • "firebaseEventParameterCampaignGclid"
  • "firebaseEventParameterCampaignSource"
  • "firebaseEventParameterCampaignTerm"
  • "firebaseEventParameterCurrency"
  • "firebaseEventParameterDynamicLinkAcceptTime"
  • "firebaseEventParameterDynamicLinkLinkid"
  • "firebaseEventParameterNotificationMessageDeviceTime"
  • "firebaseEventParameterNotificationMessageId"
  • "firebaseEventParameterNotificationMessageName"
  • "firebaseEventParameterNotificationMessageTime"
  • "firebaseEventParameterNotificationTopic"
  • "firebaseEventParameterPreviousAppVersion"
  • "firebaseEventParameterPreviousOsVersion"
  • "firebaseEventParameterPrice"
  • "firebaseEventParameterProductId"
  • "firebaseEventParameterQuantity"
  • "firebaseEventParameterValue"
  • "firstPartyServingUrl"
  • "formClasses"
  • "formElement"
  • "formId"
  • "formTarget"
  • "formText"
  • "formUrl"
  • "historySource"
  • "htmlId"
  • "language"
  • "newHistoryFragment"
  • "newHistoryState"
  • "newHistoryUrl"
  • "oldHistoryFragment"
  • "oldHistoryState"
  • "oldHistoryUrl"
  • "osVersion"
  • "pageHostname"
  • "pagePath"
  • "pageUrl"
  • "platform"
  • "queryString"
  • "randomNumber"
  • "referrer"
  • "requestMethod"
  • "requestPath"
  • "resolution"
  • "scrollDepthDirection"
  • "scrollDepthThreshold"
  • "scrollDepthUnits"
  • "sdkVersion"
  • "serverPageLocationHostname"
  • "serverPageLocationPath"
  • "serverPageLocationUrl"
  • "videoCurrentTime"
  • "videoDuration"
  • "videoPercent"
  • "videoProvider"
  • "videoStatus"
  • "videoTitle"
  • "videoUrl"
  • "videoVisible"
  • "visitorRegion"
builtInVariable[].workspaceId string GTM Workspace ID.
client[] list The clients in the container that this version was taken from.
container nested object The container that this version was taken from.
containerId string GTM Container ID.
containerVersionId string The Container Version ID uniquely identifies the GTM Container Version.
customTemplate[] list The custom templates in the container that this version was taken from.
deleted boolean A value of true indicates this container version has been deleted.
description string Container version description. writable
fingerprint string The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.
folder[] list The folders in the container that this version was taken from.
gtagConfig[] list The Google tag configs in the container that this version was taken from.
name string Container version display name. writable
path string GTM Container Version's API relative path.
tagManagerUrl string Auto generated link to the tag manager UI
tag[] list The tags in the container that this version was taken from.
transformation[] list The transformations in the container that this version was taken from.
trigger[] list The triggers in the container that this version was taken from.
variable[] list The variables in the container that this version was taken from.
zone[] list The zones in the container that this version was taken from.

Methods

delete
Deletes a Container Version.
get
Gets a Container Version.
live
Gets the live (i.e. published) container version
publish
Publishes a Container Version.
set_latest
Sets the latest version used for synchronization of workspaces when detecting conflicts and errors.
undelete
Undeletes a Container Version.
update
Updates a Container Version.