REST Resource: accounts.containers.versions

Resource: ContainerVersion
- JSON representation
BuiltInVariable
- JSON representation
BuiltInVariableType
Methods

Resource: ContainerVersion

Represents a Google Tag Manager Container Version.

JSON representation

JSON representation
{ "path": string, "accountId": string, "containerId": string, "containerVersionId": string, "name": string, "deleted": boolean, "description": string, "container": { object (`Container`) }, "tag": [ { object (`Tag`) } ], "trigger": [ { object (`Trigger`) } ], "variable": [ { object (`Variable`) } ], "folder": [ { object (`Folder`) } ], "builtInVariable": [ { object (`BuiltInVariable`) } ], "fingerprint": string, "tagManagerUrl": string, "zone": [ { object (`Zone`) } ], "customTemplate": [ { object (`CustomTemplate`) } ], "client": [ { object (`Client`) } ], "gtagConfig": [ { object (`GtagConfig`) } ], "transformation": [ { object (`Transformation`) } ] }

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "containerVersionId": string,
  "name": string,
  "deleted": boolean,
  "description": string,
  "container": {
    object (Container)
  },
  "tag": [
    {
      object (Tag)
    }
  ],
  "trigger": [
    {
      object (Trigger)
    }
  ],
  "variable": [
    {
      object (Variable)
    }
  ],
  "folder": [
    {
      object (Folder)
    }
  ],
  "builtInVariable": [
    {
      object (BuiltInVariable)
    }
  ],
  "fingerprint": string,
  "tagManagerUrl": string,
  "zone": [
    {
      object (Zone)
    }
  ],
  "customTemplate": [
    {
      object (CustomTemplate)
    }
  ],
  "client": [
    {
      object (Client)
    }
  ],
  "gtagConfig": [
    {
      object (GtagConfig)
    }
  ],
  "transformation": [
    {
      object (Transformation)
    }
  ]
}

Fields
`path`	`string` GTM Container Version's API relative path.
`accountId`	`string` GTM Account ID.
`containerId`	`string` GTM Container ID.
`containerVersionId`	`string` The Container Version ID uniquely identifies the GTM Container Version.
`name`	`string` Container version display name.
`deleted`	`boolean` A value of true indicates this container version has been deleted.
`description`	`string` Container version description.
`container`	`object (Container)` The container that this version was taken from.
`tag[]`	`object (Tag)` The tags in the container that this version was taken from.
`trigger[]`	`object (Trigger)` The triggers in the container that this version was taken from.
`variable[]`	`object (Variable)` The variables in the container that this version was taken from.
`folder[]`	`object (Folder)` The folders in the container that this version was taken from.
`builtInVariable[]`	`object (BuiltInVariable)` The built-in variables in the container that this version was taken from.
`fingerprint`	`string` The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.
`tagManagerUrl`	`string` Auto generated link to the tag manager UI
`zone[]`	`object (Zone)` The zones in the container that this version was taken from.
`customTemplate[]`	`object (CustomTemplate)` The custom templates in the container that this version was taken from.
`client[]`	`object (Client)` The clients in the container that this version was taken from.
`gtagConfig[]`	`object (GtagConfig)` The Google tag configs in the container that this version was taken from.
`transformation[]`	`object (Transformation)` The transformations in the container that this version was taken from.

BuiltInVariable

Built-in variables are a special category of variables that are pre-created and non-customizable. They provide common functionality like accessing properties of the gtm data layer, monitoring clicks, or accessing elements of a page URL.

JSON representation
{ "path": string, "accountId": string, "containerId": string, "workspaceId": string, "type": enum (`BuiltInVariableType`), "name": string }

Fields
`path`	`string` GTM BuiltInVariable's API relative path.
`accountId`	`string` GTM Account ID.
`containerId`	`string` GTM Container ID.
`workspaceId`	`string` GTM Workspace ID.
`type`	`enum (BuiltInVariableType)` Type of built-in variable.
`name`	`string` Name of the built-in variable to be used to refer to the built-in variable.

BuiltInVariableType

Note that BuiltInVariableType must be binary compatible with container_tag.BuiltInType.BuiltInMacroType. LINT.IfChange NEXT TAG: 141

Enums
`builtInVariableTypeUnspecified`
`pageUrl`
`pageHostname`
`pagePath`
`referrer`
`event`	For web or mobile.
`clickElement`
`clickClasses`
`clickId`
`clickTarget`
`clickUrl`
`clickText`
`firstPartyServingUrl`
`formElement`
`formClasses`
`formId`
`formTarget`
`formUrl`
`formText`
`errorMessage`
`errorUrl`
`errorLine`
`newHistoryUrl`
`oldHistoryUrl`
`newHistoryFragment`
`oldHistoryFragment`
`newHistoryState`
`oldHistoryState`
`historySource`
`containerVersion`	For web or mobile.
`debugMode`
`randomNumber`	For web or mobile.
`containerId`	For web or mobile.
`appId`
`appName`
`appVersionCode`
`appVersionName`
`language`
`osVersion`
`platform`
`sdkVersion`
`deviceName`
`resolution`
`advertiserId`
`advertisingTrackingEnabled`
`htmlId`
`environmentName`
`ampBrowserLanguage`
`ampCanonicalPath`
`ampCanonicalUrl`
`ampCanonicalHost`
`ampReferrer`
`ampTitle`
`ampClientId`
`ampClientTimezone`
`ampClientTimestamp`
`ampClientScreenWidth`
`ampClientScreenHeight`
`ampClientScrollX`
`ampClientScrollY`
`ampClientMaxScrollX`
`ampClientMaxScrollY`
`ampTotalEngagedTime`
`ampPageViewId`
`ampPageLoadTime`
`ampPageDownloadTime`
`ampGtmEvent`
`eventName`
`firebaseEventParameterCampaign`
`firebaseEventParameterCampaignAclid`
`firebaseEventParameterCampaignAnid`
`firebaseEventParameterCampaignClickTimestamp`
`firebaseEventParameterCampaignContent`
`firebaseEventParameterCampaignCp1`
`firebaseEventParameterCampaignGclid`
`firebaseEventParameterCampaignSource`
`firebaseEventParameterCampaignTerm`
`firebaseEventParameterCurrency`
`firebaseEventParameterDynamicLinkAcceptTime`
`firebaseEventParameterDynamicLinkLinkid`
`firebaseEventParameterNotificationMessageDeviceTime`
`firebaseEventParameterNotificationMessageId`
`firebaseEventParameterNotificationMessageName`
`firebaseEventParameterNotificationMessageTime`
`firebaseEventParameterNotificationTopic`
`firebaseEventParameterPreviousAppVersion`
`firebaseEventParameterPreviousOsVersion`
`firebaseEventParameterPrice`
`firebaseEventParameterProductId`
`firebaseEventParameterQuantity`
`firebaseEventParameterValue`
`videoProvider`
`videoUrl`
`videoTitle`
`videoDuration`
`videoPercent`
`videoVisible`
`videoStatus`
`videoCurrentTime`
`scrollDepthThreshold`
`scrollDepthUnits`
`scrollDepthDirection`
`elementVisibilityRatio`
`elementVisibilityTime`
`elementVisibilityFirstTime`
`elementVisibilityRecentTime`
`requestPath`
`requestMethod`
`clientName`
`queryString`
`serverPageLocationUrl`
`serverPageLocationPath`
`serverPageLocationHostname`
`visitorRegion`

Methods
`delete`	Deletes a Container Version.
`get`	Gets a Container Version.
`live`	Gets the live (i.e.
`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.

REST Resource: accounts.containers.versions

Resource: ContainerVersion

BuiltInVariable

BuiltInVariableType

Methods

`delete`

`get`

`live`

`publish`

`set_latest`

`undelete`

`update`