Built-In Variables: create

创建一个或多个 GTM 内置变量。立即试用。

请求

HTTP 请求

POST https://www.googleapis.com/tagmanager/v2/+parent/built_in_variables

参数

参数名称 值 说明
路径参数
parent string GTM 工作区的 API 相对路径。示例：accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}
可选的查询参数
type string 要启用的内置变量的类型。

可接受的值包括：
  • “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”

授权

此请求需要获得以下范围的授权：

范围
https://www.googleapis.com/auth/tagmanager.edit.containers

如需了解详情，请参阅身份验证和授权页面。

请求正文

使用此方法时请勿提供请求正文。

响应

如果成功，此方法将返回采用以下结构的响应正文：

{
  "builtInVariable": [
    {
      "path": string,
      "accountId": string,
      "containerId": string,
      "workspaceId": string,
      "type": string,
      "name": string
    }
  ]
}
属性名称 值 说明 备注
builtInVariable[] list 已创建的内置变量列表。
builtInVariable[].path string GTM 内置变量的 API 相对路径。
builtInVariable[].accountId string GTM 账号 ID。
builtInVariable[].containerId string GTM 容器 ID。
builtInVariable[].workspaceId string GTM 工作区 ID。
builtInVariable[].type string 内置变量的类型。

可接受的值：
  • “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[].name string 用于指代内置变量的内置变量名称。

试试看！

使用下面的 API Explorer 对实际数据调用此方法，然后查看响应。