Macros

コンテナのマクロです。マクロは、ランタイムに評価される値を表します。ルールとタグを設定する際にマクロを参照できます。詳細については、Google タグ マネージャーのマクロで設定できるプロパティの詳細については、マクロ辞書リファレンスをご覧ください。マクロの設定方法と使用方法について詳しくは、Google タグ マネージャー ヘルプセンターのマクロをご覧ください。

このリソースのメソッドの一覧については、このページの最後をご覧ください。

リソースの表記

Google タグ マネージャーのマクロを表します。

{
  "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
}
プロパティ名 説明 メモ
accountId string GTM アカウント ID。
containerId string GTM コンテナ ID。
disablingRuleId[] list モバイル コンテナのみ: 条件付きマクロを有効にするためのルール ID のリスト。すべての無効化ルールが false である一方で、有効化ルールの 1 つが true の場合、マクロは有効になります。順不同のセットとして扱われます。 書き込み可能
enablingRuleId[] list モバイル コンテナのみ: 条件変数を有効にするためのルール ID のリスト。すべての無効化ルールーが false である一方で、有効化ルールの 1 つが true の場合、マクロは有効になります。順不同のセットとして扱われます。 書き込み可能
fingerprint string 保存時に計算された GTM マクロのフィンガープリント。この値は、マクロが変更されるたびに再計算されます。
macroId string GTM マクロを一意に識別するマクロ ID。
name string マクロの表示名。 書き込み可能
notes string コンテナでこのマクロを利用する方法についてのユーザーのメモ。 書き込み可能
parameter[] list マクロのパラメータ。 書き込み可能
parameter[].key string パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。 書き込み可能
parameter[].list[] list このリスト パラメータのパラメータ(キーは無視されます)。 書き込み可能
parameter[].map[] list このマップ パラメータのパラメータ(一意のキーが必要)。 書き込み可能
parameter[].type string パラメータの型。有効な値は次のとおりです。
  • boolean: ブール値(「true」または「false」)
  • integer: 64 ビット符号付き整数値(10 進数)
  • list: パラメータのリスト
  • map: パラメータのマップ
  • template: 任意のテキストを表します。マクロ参照も含めることができます(文字列以外の型を返すマクロ参照も含みます)。


有効な値は次のとおりです。
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
書き込み可能
parameter[].value string 指定された型のパラメータ値(「」などマクロの参照も使用できます)。 書き込み可能
parentFolderId string 親フォルダ ID。
scheduleEndMs long マクロをスケジュール設定する終了タイムスタンプ(ミリ秒単位)。 書き込み可能
scheduleStartMs long マクロをスケジュール設定する開始タイムスタンプ(ミリ秒単位)。 書き込み可能
type string GTM マクロのタイプ。 書き込み可能

Methods

マクロを作成、変更、削除、または取得するためのメソッドは以下のとおりです。

create
GTM マクロを作成します。
delete
GTM マクロを削除します。
get
GTM マクロを取得します。
list
コンテナのすべての GTM マクロを一覧表示します。
update
GTM マクロを更新します。