Environments

このリソースのメソッドの一覧は、このページの最後に掲載されています。

リソースの表記

Google タグ マネージャーの環境を表します。ユーザーは USER タイプの環境を作成、削除、更新できますが、他のタイプの環境については enable_debug フィールドと url フィールドのみ更新できます。

{
  "accountId": string,
  "containerId": string,
  "environmentId": string,
  "type": string,
  "fingerprint": string,
  "name": string,
  "description": string,
  "enableDebug": boolean,
  "url": string,
  "authorizationCode": string,
  "authorizationTimestampMs": long,
  "containerVersionId": string
}
プロパティ名 説明 メモ
accountId string GTM アカウント ID。
authorizationCode string 環境の認証コード。
authorizationTimestampMs long 認証コードの最終更新のタイムスタンプ。
containerId string GTM コンテナ ID。
containerVersionId string

description string 環境の説明。USER タイプの環境でのみ設定や変更を行えます。 書き込み可能
enableDebug boolean 環境のデバッグをデフォルトで有効にするかどうか。 書き込み可能
environmentId string GTM 環境を一意に識別する GTM 環境 ID。
fingerprint string 保存時に計算された GTM 環境のフィンガープリント。この値は、環境が変更されるたびに再計算されます。
name string 環境の表示名。USER タイプの環境でのみ設定や変更を行えます。 書き込み可能
type string この環境のタイプ。

有効な値は次のとおりです。
  • "draft"
  • "latest"
  • "live"
  • "user"
url string 環境のデフォルトのプレビュー ページの URL。 書き込み可能

Methods

create
GTM 環境を作成します。
delete
GTM 環境を削除します。
get
GTM 環境を取得します。
list
GTM コンテナのすべての GTM 環境を一覧表示します。
update
GTM 環境を更新します。