Container Versions

コンテナのコンテナ バージョン。コンテナ バージョンは、特定の時点におけるコンテナ設定の不変コピー（スナップショット）と考えることができます。create メソッドを使用して新しいバージョンを作成すると、現在の設定（コンテナのマクロ、ルール、タグなど）に基づいてバージョンが作成されます。restore メソッドは、指定されたバージョンを使用してコンテナの構成を復元します。update メソッドを使用すると、バージョンの name フィールドと notes フィールドを更新できます。現在公開されているバージョンを取得するには、get メソッドを使用して、containerVersionId に published を指定します。

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

リソース表現

Google タグ マネージャーのコンテナ バージョンを表します。

{
  "accountId": string,
  "containerId": string,
  "containerVersionId": string,
  "name": string,
  "deleted": boolean,
  "notes": string,
  "container": accounts.containers Resource,
  "macro": [
    {
      "accountId": string,
      "containerId": string,
      "macroId": string,
      "name": string,
      "type": string,
      "notes": string,
      "scheduleStartMs": long,
      "scheduleEndMs": long,
      "parameter": [
        {
          "type": string,
          "key": string,
          "value": string,
          "list": [
            (Parameter)
          ],
          "map": [
            (Parameter)
          ]
        }
      ],
      "enablingRuleId": [
        string
      ],
      "disablingRuleId": [
        string
      ],
      "fingerprint": string,
      "parentFolderId": string
    }
  ],
  "rule": [
    {
      "accountId": string,
      "containerId": string,
      "ruleId": string,
      "name": string,
      "notes": string,
      "condition": [
        {
          "type": string,
          "parameter": [
            {
              "type": string,
              "key": string,
              "value": string,
              "list": [
                (Parameter)
              ],
              "map": [
                (Parameter)
              ]
            }
          ]
        }
      ],
      "fingerprint": string
    }
  ],
  "tag": [
    accounts.containers.tags Resource
  ],
  "trigger": [
    accounts.containers.triggers Resource
  ],
  "variable": [
    accounts.containers.variables Resource
  ],
  "folder": [
    accounts.containers.folders Resource
  ],
  "fingerprint": string
}

プロパティ名	値	説明	メモ
accountId	string	GTM アカウント ID。
container	nested object	このバージョンの取得元コンテナ。
containerId	string	GTM コンテナ ID。
containerVersionId	string	containerVersionId は GTM コンテナ バージョンを一意に識別する文字列です。
deleted	boolean	値が true の場合、このコンテナ バージョンは削除されています。
fingerprint	string	保存時に計算された GTM コンテナ バージョンのフィンガープリント。この値は、コンテナ バージョンが変更されるたびに再計算されます。
folder[]	list	このバージョンの取得元コンテナのフォルダ。
macro[]	list	このバージョンの取得元コンテナのマクロ。
macro[].accountId	string	GTM アカウント ID。
macro[].containerId	string	GTM コンテナ ID。
macro[].disablingRuleId[]	list	モバイル コンテナのみ: 条件付きマクロを有効にするためのルール ID のリスト。すべての無効化ルールが false である一方で、有効化ルールの 1 つが true の場合、マクロは有効になります。順不同のセットとして扱われます。
macro[].enablingRuleId[]	list	モバイル コンテナのみ: 条件変数を有効にするためのルール ID のリスト。すべての無効化ルールーが false である一方で、有効化ルールの 1 つが true の場合、マクロは有効になります。順不同のセットとして扱われます。
macro[].fingerprint	string	保存時に計算された GTM マクロのフィンガープリント。この値は、マクロが変更されるたびに再計算されます。
macro[].macroId	string	GTM マクロを一意に識別するマクロ ID。
macro[].name	string	マクロの表示名。
macro[].notes	string	コンテナでこのマクロを利用する方法についてのユーザーのメモ。
macro[].parameter[]	list	マクロのパラメータ。
macro[].parameter[].key	string	パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。	書き込み可能
macro[].parameter[].list[]	list	このリスト パラメータのパラメータ（キーは無視されます）。	書き込み可能
macro[].parameter[].map[]	list	このマップ パラメータのパラメータ（一意のキーが必要）。	書き込み可能
macro[].parameter[].type	string	パラメータの型。有効な値は次のとおりです。 boolean: ブール値（「true」または「false」） integer: 64 ビット符号付き整数値（10 進数） list: パラメータのリスト map: パラメータのマップ template: 任意のテキスト。変数参照も使用可能（文字列以外の型を返す変数参照にも対応） trigger_reference: トリガーを表す値（トリガー ID） 有効な値は次のとおりです。 "boolean" "integer" "list" "map" "template" 「triggerReference」	書き込み可能
macro[].parameter[].value	string	指定された型のパラメータ値（「」などの変数参照も使用可）。	書き込み可能
macro[].parentFolderId	string	親フォルダ ID。
macro[].scheduleEndMs	long	マクロをスケジュール設定する終了タイムスタンプ（ミリ秒単位）。
macro[].scheduleStartMs	long	マクロをスケジュール設定する開始タイムスタンプ（ミリ秒単位）。
macro[].type	string	GTM マクロのタイプ。
name	string	コンテナ バージョンの表示名。	書き込み可能
notes	string	コンテナでこのコンテナ バージョンを利用する方法についてのユーザーのメモ。	書き込み可能
rule[]	list	このバージョンの取得元コンテナのルール。
rule[].accountId	string	GTM アカウント ID。
rule[].condition[]	list	このルールを構成する条件のリスト（条件は暗黙的に「AND」で連結）。
rule[].condition[].parameter[]	list	条件の種類に応じた名前付きパラメータ（Key-Value）のリスト。備考: 二項演算子の場合は、arg0 および arg1 というパラメータで、左と右のオペランドをそれぞれ指定します。 このとき、左のオペランド（arg0）は必ず変数の参照にします。 正規表現のマッチングで大文字と小文字を区別しない場合は、ignore_case というブール型パラメータを true に設定します。このパラメータが設定されていない場合や、他の値が設定されている場合は、大文字と小文字が区別されます。 演算子を無効にするには、negate というブール型パラメータを true に設定します。	書き込み可能
rule[].condition[].parameter[].key	string	パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。	書き込み可能
rule[].condition[].parameter[].list[]	list	このリスト パラメータのパラメータ（キーは無視されます）。	書き込み可能
rule[].condition[].parameter[].map[]	list	このマップ パラメータのパラメータ（一意のキーが必要）。	書き込み可能
rule[].condition[].parameter[].type	string	パラメータの型。有効な値は次のとおりです。 boolean: ブール値（「true」または「false」） integer: 64 ビット符号付き整数値（10 進数） list: パラメータのリスト map: パラメータのマップ template: 任意のテキスト。変数参照も使用可能（文字列以外の型を返す変数参照にも対応） trigger_reference: トリガーを表す値（トリガー ID） 有効な値は次のとおりです。 "boolean" "integer" "list" "map" "template" 「triggerReference」	書き込み可能
rule[].condition[].parameter[].value	string	指定された型のパラメータ値（「」などの変数参照も使用可）。	書き込み可能
rule[].condition[].type	string	この条件の演算子。 有効な値は次のとおりです。 "contains" "cssSelector" "endsWith" "equals" "greater" "greaterOrEquals" "less" "lessOrEquals" "matchRegex" "startsWith" 「urlMatches」	書き込み可能
rule[].containerId	string	GTM コンテナ ID。
rule[].fingerprint	string	保存時に計算された GTM ルールのフィンガープリント。この値は、ルールが変更されるたびに再計算されます。
rule[].name	string	ルールの表示名。
rule[].notes	string	コンテナでこのルールを利用する方法についてのユーザーのメモ。
rule[].ruleId	string	GTM ルールを一意に識別するルール ID。
tag[]	list	このバージョンの取得元コンテナのタグ。
trigger[]	list	このバージョンの取得元コンテナのトリガー。
variable[]	list	このバージョンの取得元コンテナの変数。

メソッド

create

コンテナのバージョンを作成します。

delete

コンテナのバージョンを削除します。

get

コンテナのバージョンを取得します。

list

GTM コンテナのすべてのコンテナ バージョンを一覧表示します。

publish

コンテナのバージョンを公開します。

復元

コンテナのバージョンを復元します。これにより、コンテナの現在の設定（変数、トリガー、タグなど）が上書きされます。この操作は、配信中（公開中）のバージョンには何の影響も与えません。

undelete

コンテナのバージョンの削除を取り消します。

update

コンテナのバージョンを更新します。