REST Resource: accounts.containers.environments

リソース: Environment

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

JSON 表現
{
  "accountId": string,
  "containerId": string,
  "environmentId": string,
  "type": enum (EnvironmentType),
  "fingerprint": string,
  "name": string,
  "description": string,
  "enableDebug": boolean,
  "url": string,
  "authorizationCode": string,
  "authorizationTimestampMs": string,

  // Union field Link can be only one of the following:
  "containerVersionId": string
  // End of list of possible types for union field Link.
}
フィールド
accountId

string

GTM アカウント ID。

containerId

string

GTM コンテナ ID。

environmentId

string

GTM 環境を一意に識別する GTM 環境 ID。

type

enum (EnvironmentType)

この環境のタイプ。

fingerprint

string

保存時に計算された GTM 環境のフィンガープリント。この値は、環境が変更されるたびに再計算されます。

name

string

環境の表示名。USER タイプの環境でのみ設定や変更を行えます。

description

string

環境の説明。USER タイプの環境でのみ設定や変更を行えます。

enableDebug

boolean

環境のデバッグをデフォルトで有効にするかどうか。

url

string

環境のデフォルトのプレビュー ページの URL。

authorizationCode

string

環境の認証コード。

authorizationTimestampMs

string (int64 format)

認証コードの最終更新のタイムスタンプ。

containerVersionId

string

EnvironmentType

列挙型
user ユーザー定義の環境に使用されます。
live 公開されたコンテナのバージョンを参照する本番環境に使用します。
latest 最新の環境に使用されます。これは、最後に作成されたコンテナ バージョンを参照します。
draft コンテナ内の単一の下書きを指す下書き環境に使用されます。

メソッド

create

GTM 環境を作成します。

delete

GTM 環境を削除します。

get

GTM 環境を取得します。

list

GTM コンテナのすべての GTM 環境を一覧表示します。

update

GTM 環境を更新します。