Zones

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

リソースの表記

Google タグ マネージャー(GTM)ゾーンのコンテンツを表します。

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "zoneId": string,
  "name": string,
  "fingerprint": string,
  "tagManagerUrl": string,
  "notes": string,
  "childContainer": [
    {
      "publicId": string,
      "nickname": string
    }
  ],
  "boundary": {
    "condition": [
      {
        "type": string,
        "parameter": [
          {
            "type": string,
            "key": string,
            "value": string,
            "list": [
              (Parameter)
            ],
            "map": [
              (Parameter)
            ]
          }
        ]
      }
    ],
    "customEvaluationTriggerId": [
      string
    ]
  },
  "typeRestriction": {
    "enable": boolean,
    "whitelistedTypeId": [
      string
    ]
  }
}
プロパティ名 説明 メモ
accountId string GTM アカウント ID。
boundary nested object このゾーンの境界。
boundary.condition[] list 結合により境界を構成する条件。
boundary.condition[].parameter[] list 条件の種類に応じた名前付きパラメータ(Key-Value)のリスト。注意事項は次のとおりです。
  • 二項演算子の場合は、arg0arg1 というパラメータで左と右のオペランドを指定します。
  • このとき、左のオペランド(arg0)は必ず変数の参照にします。
  • 正規表現のマッチングで大文字と小文字を区別しない場合は、ignore_case というブール型パラメータを true に設定します。このパラメータが設定されていない場合や、他の値が設定されている場合は、大文字と小文字が区別されます。
  • 演算子を無効にするには、negate というブール型パラメータを true に設定します。
書き込み可能
boundary.condition[].parameter[].key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
boundary.condition[].parameter[].list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
boundary.condition[].parameter[].map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
boundary.condition[].parameter[].type string パラメータの型。指定できる値は次のとおりです。
  • boolean: ブール値(「true」または「false」)
  • integer: 64 ビット符号付き整数値(10 進数)
  • list: パラメータのリスト
  • map: パラメータのマップ
  • template: 任意のテキスト。変数参照も使用可能(文字列以外の型を返す変数参照にも対応)
  • trigger_reference: トリガーを表す値(トリガー ID)


有効な値は次のとおりです。
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
書き込み可能
boundary.condition[].parameter[].value string 指定された型のパラメータ値(「{{myVariable}}」などの変数参照も使用可)。 書き込み可能
boundary.condition[].type string この条件の演算子。

有効な値は次のとおりです。
  • "conditionTypeUnspecified"
  • "contains"
  • "cssSelector"
  • "endsWith"
  • "equals"
  • "greater"
  • "greaterOrEquals"
  • "less"
  • "lessOrEquals"
  • "matchRegex"
  • "startsWith"
  • "urlMatches"
書き込み可能
boundary.customEvaluationTriggerId[] list カスタム評価トリガー ID。リストにあるトリガーのいずれかが true の場合、境界の条件がゾーンにより評価されます。
childContainer[] list このゾーンの子であるコンテナ。
childContainer[].nickname string 子コンテナのゾーンでのニックネーム。
childContainer[].publicId string 子コンテナの公開 ID。
containerId string GTM コンテナ ID。
fingerprint string 保存時に計算された GTM ゾーンのフィンガープリント。この値は、ゾーンが変更されるたびに再計算されます。
name string ゾーンの表示名。
notes string コンテナでこのゾーンを利用する方法についてのユーザーのメモ。
path string GTM ゾーンの API 相対パス。
tagManagerUrl string タグ マネージャーの管理画面への自動生成リンク。
typeRestriction nested object このゾーンのタイプの制限。
typeRestriction.enable boolean このゾーンでタイプの制限が有効になっている場合は true になります。
typeRestriction.whitelistedTypeId[] list このゾーンで使用できるように、ホワイトリストに登録されているタイプの公開 ID のリスト。
workspaceId string GTM ワークスペース ID。
zoneId string GTM ゾーンを一意に識別するゾーン ID。

メソッド

create
GTM ゾーンを作成します。
delete
GTM ゾーンを削除します。
get
GTM ゾーンを取得します。
list
GTM コンテナ ワークスペースのすべての GTM ゾーンを一覧表示します。
revert
GTM ワークスペースの GTM ゾーンに加えた変更を元に戻します。
update
GTM ゾーンを更新します。