Clients

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

リソースの表記

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "clientId": string,
  "name": string,
  "type": string,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "priority": integer,
  "fingerprint": string,
  "tagManagerUrl": string,
  "parentFolderId": string,
  "notes": string
}

プロパティ名	値	説明	メモ
accountId	string	GTM アカウント ID。
clientId	string	クライアント ID は、GTM クライアントを一意に識別するものです。
containerId	string	GTM コンテナ ID。
fingerprint	string	保存時に計算された GTM クライアントのフィンガープリント。この値は、クライアントが変更されるたびに再計算されます。
name	string	クライアントの表示名。	書き込み可能
notes	string	コンテナでこのタグを利用する方法についてのユーザーのメモ。	書き込み可能
parameter[]	list	クライアントのパラメータ。	書き込み可能
parameter[].isWeakReference	boolean	参照型のパラメータが強参照または弱参照かどうか。変換でのみ使用できます。	書き込み可能
parameter[].key	string	パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。	書き込み可能
parameter[].list[]	list	このリスト パラメータのパラメータ（キーは無視されます）。	書き込み可能
parameter[].map[]	list	このマップ パラメータのパラメータ（一意のキーが必要）。	書き込み可能
parameter[].type	string	パラメータの型。有効な値は次のとおりです。 boolean: ブール値（「true」または「false」） integer: 64 ビット符号付き整数値（10 進数） list: パラメータのリスト map: パラメータのマップ template: 任意のテキスト。変数参照も使用可能（文字列以外の型を返す変数参照にも対応） trigger_reference: トリガーを表す値（トリガー ID） tag_reference: タグを表す値（タグ名） 有効な値は次のとおりです。 "boolean" "integer" "list" "map" "tagReference" "template" "triggerReference" "typeUnspecified"	書き込み可能
parameter[].value	string	指定された型のパラメータ値（「」などの変数参照も使用可）。	書き込み可能
parentFolderId	string	親フォルダ ID。
path	string	GTM クライアントの API 相対パス。
priority	integer	優先度により、相対的な配信順序が決まります。	書き込み可能
tagManagerUrl	string	タグ マネージャーの管理画面への自動生成リンク。
type	string	クライアントの種類。	書き込み可能
workspaceId	string	GTM ワークスペース ID。

Methods

create

GTM クライアントを作成します。

delete

GTM クライアントを削除します。

get

GTM クライアントを取得します。

list

GTM コンテナ ワークスペースのすべての GTM クライアントを一覧表示します。

revert

GTM ワークスペース内の GTM クライアントに加えた変更を元に戻します。

update

GTM クライアントを更新します。