Google の新しいタグ プラットフォームに関するドキュメントをご覧いただきありがとうございます。このサイトは公開ベータ版です。(フィードバック

Built-In Variables: list

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

GTM コンテナのすべての有効な組み込み変数を一覧表示します。 実習をご覧ください。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 説明
パスパラメータ
parent string GTM ワークスペースの API 相対パス。 例: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}
省略可能なクエリ パラメータ
pageToken string 結果の次のページを取得するための継続トークン。

承認

このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。

範囲
https://www.googleapis.com/auth/tagmanager.edit.containers
https://www.googleapis.com/auth/tagmanager.readonly

詳細については、認証と承認のページをご覧ください。

リクエスト本文

このメソッドをリクエストの本文に含めないでください。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "builtInVariable": [
    {
      "path": string,
      "accountId": string,
      "containerId": string,
      "workspaceId": string,
      "type": string,
      "name": string
    }
  ],
  "nextPageToken": string
}
プロパティ名 説明 備考
builtInVariable[] list GTM コンテナのすべての GTM BuiltInVariable。
builtInVariable[].path string GTM BuiltInVariable の 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"
builtInVariable[].name string 組み込み変数の参照に使用する組み込み変数の名前。
nextPageToken string 結果の次のページを取得するための継続トークン。

実習

以下の API Explorer を使用して、ライブデータでこのメソッドを呼び出し、レスポンスを確認します。