Environments

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

リソースの表記

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

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "environmentId": string,
  "type": string,
  "fingerprint": string,
  "name": string,
  "description": string,
  "enableDebug": boolean,
  "url": string,
  "authorizationCode": string,
  "authorizationTimestamp": {
    "seconds": long,
    "nanos": integer
  },
  "containerVersionId": string,
  "workspaceId": string,
  "tagManagerUrl": string
}

プロパティ名	値	説明	メモ
accountId	string	GTM アカウント ID。
authorizationCode	string	環境の認証コード。
authorizationTimestamp	nested object	認証コードの最終更新のタイムスタンプ。
authorizationTimestamp.nanos	integer	非負の小数以下の秒数（ナノ秒単位）。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0～999,999,999 の範囲（境界を含む）になります。
authorizationTimestamp.seconds	long	Unix エポック 1970-01-01T00:00:00Z からの UTC 時間の秒数を表します。0001-01-01T00:00:00Z ～ 9999-12-31T23:59:59Z の範囲（両端を含む）にする必要があります。
containerId	string	GTM コンテナ ID。
containerVersionId	string	コンテナ バージョンへのリンクを表します。
description	string	環境の説明。USER タイプの環境でのみ設定や変更を行えます。	書き込み可能
enableDebug	boolean	環境のデバッグをデフォルトで有効にするかどうか。	書き込み可能
environmentId	string	GTM 環境を一意に識別する GTM 環境 ID。
fingerprint	string	保存時に計算された GTM 環境のフィンガープリント。この値は、環境が変更されるたびに再計算されます。
name	string	環境の表示名。USER タイプの環境でのみ設定や変更を行えます。	書き込み可能
path	string	GTM 環境の API 相対パス。
tagManagerUrl	string	タグ マネージャーの管理画面への自動生成リンク。
type	string	この環境のタイプ。 有効な値は次のとおりです。 "latest" "live" "user" "workspace"
url	string	環境のデフォルトのプレビュー ページの URL。	書き込み可能
workspaceId	string	ワークスペースのクイック プレビューへのリンクを表します。

Methods

create

GTM 環境を作成します。

delete

GTM 環境を削除します。

get

GTM 環境を取得します。

list

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

reauthorize

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

update

GTM 環境を更新します。