REST Resource: accounts.containers.environments

リソース: Environment

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

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

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

string

GTM 環境の API 相対パス。
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

環境の認証コード。
authorizationTimestamp

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
tagManagerUrl

string

タグ マネージャーの管理画面への自動生成リンク。
containerVersionId

string

コンテナ バージョンへのリンクを表します。
workspaceId

string

ワークスペースのクイック プレビューへのリンクを表します。

EnvironmentType

列挙型
user ユーザー定義の環境を指します。
live 現在のライブ コンテナ バージョンを指します。
latest 最新のコンテナ バージョンを指します。
workspace ワークスペースによって作成されたワークスペースのプレビューまたはバージョンを指す、自動管理環境。

メソッド

create

 GTM 環境を作成します。

delete

 GTM 環境を削除します。

get

 GTM 環境を取得します。

list

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

reauthorize

 GTM 環境の認証コードを再生成します。

update

 GTM 環境を更新します。