REST Resource: accounts.containers

Resource: Container
Methods

Resource: Container

Represents a Google Tag Manager Container.

JSON representation

JSON representation
{ "accountId": string, "containerId": string, "name": string, "domainName": [ string ], "publicId": string, "timeZoneCountryId": string, "timeZoneId": string, "notes": string, "usageContext": [ enum (`UsageContext`) ], "enabledBuiltInVariable": [ enum (`BuiltInVariableType`) ], "fingerprint": string }

{
  "accountId": string,
  "containerId": string,
  "name": string,
  "domainName": [
    string
  ],
  "publicId": string,
  "timeZoneCountryId": string,
  "timeZoneId": string,
  "notes": string,
  "usageContext": [
    enum (UsageContext)
  ],
  "enabledBuiltInVariable": [
    enum (BuiltInVariableType)
  ],
  "fingerprint": string
}

Fields

Fields
`accountId`	`string` GTM Account ID.
`containerId`	`string` The Container ID uniquely identifies the GTM Container.
`name`	`string` Container display name.
`domainName[]`	`string` Optional list of domain names associated with the Container.
`publicId`	`string` Container Public ID.
`timeZoneCountryId`	`string` Container Country ID.
`timeZoneId`	`string` Container Time Zone ID.
`notes`	`string` Container Notes.
`usageContext[]`	`enum (UsageContext)` List of Usage Contexts for the Container. Valid values include: `web, android, ios` .
`enabledBuiltInVariable[]`	`enum (BuiltInVariableType)` List of enabled built-in variables. Valid values include: `pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId` .
`fingerprint`	`string` The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.

accountId

string

GTM Account ID.

containerId

string

The Container ID uniquely identifies the GTM Container.

name

string

Container display name.

domainName[]

string

Optional list of domain names associated with the Container.

publicId

string

Container Public ID.

timeZoneCountryId

string

Container Country ID.

timeZoneId

string

Container Time Zone ID.

notes

string

Container Notes.

usageContext[]

enum (UsageContext)

List of Usage Contexts for the Container. Valid values include:

web, android, ios

enabledBuiltInVariable[]

enum (BuiltInVariableType)

List of enabled built-in variables. Valid values include:

pageUrl, pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, historySource, containerVersion, debugMode, randomNumber, containerId

fingerprint

string

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

UsageContext

Enums

web

android

ios

androidSdk5

iosSdk5

amp

Enums
`web`
`android`
`ios`
`androidSdk5`
`iosSdk5`
`amp`

BuiltInVariableType

Each following built-in variable's enum number must be exactly same as its counterpart in BuiltInType.BuiltInMacroType. NEXT TAG: 124

Enums

pageUrl

pageHostname

pagePath

referrer

event For web or mobile.

clickElement

clickClasses

clickId

clickTarget

clickUrl

clickText

firstPartyServingUrl

formElement

formClasses

formId

formTarget

formUrl

formText

environmentName

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

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

Enums
`pageUrl`
`pageHostname`
`pagePath`
`referrer`
`event`	For web or mobile.
`clickElement`
`clickClasses`
`clickId`
`clickTarget`
`clickUrl`
`clickText`
`firstPartyServingUrl`
`formElement`
`formClasses`
`formId`
`formTarget`
`formUrl`
`formText`
`environmentName`
`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`
`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`

Methods
`create`	Creates a Container.
`delete`	Deletes a Container.
`get`	Gets a Container.
`list`	Lists all Containers that belongs to a GTM Account.
`update`	Updates a Container.

REST Resource: accounts.containers

Resource: Container

UsageContext

BuiltInVariableType

Methods

`create`

`delete`

`get`

`list`

`update`