このページは Cloud Translation API によって翻訳されました。

Tags

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

リソースの表記

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

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    string
  ],
  "liveOnly": boolean,
  "priority": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      "tagName": string,
      "stopOnSetupFailure": boolean
    }
  ],
  "teardownTag": [
    {
      "tagName": string,
      "stopTeardownOnFailure": boolean
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": string,
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    "consentStatus": string,
    "consentType": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  }
}

プロパティ名	値	説明	メモ
`accountId`	`string`	GTM アカウント ID。
`blockingRuleId[]`	`list`	ブロックルール ID。リストにあるルールのいずれかが true の場合、タグは配信されません。	書き込み可能
`blockingTriggerId[]`	`list`	ブロックトリガー ID。リストにあるトリガーのいずれかが true の場合、タグは配信されません。	書き込み可能
`consentSettings`	`nested object`	タグの同意設定。	書き込み可能
`consentSettings.consentStatus`	`string`	タグの同意ステータス。NEEDED に設定した場合、ランタイムは、`consent_type` フィールドで指定された同意タイプが付与されていることを確認します。有効な値は次のとおりです。 "`needed`" "`notNeeded`" "`notSet`"
`consentSettings.consentType`	`nested object`	「同意が必要」ステータスの場合に、タグの配信時に確認する同意の種類。このパラメータは、各リスト項目が `STRING` 型である `LIST` 型にする必要があります。
`consentSettings.consentType.isWeakReference`	`boolean`	参照型のパラメータが強参照または弱参照かどうか。変換でのみ使用できます。	書き込み可能
`consentSettings.consentType.key`	`string`	パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。	書き込み可能
`consentSettings.consentType.list[]`	`list`	このリストパラメータのパラメータ（キーは無視されます）。	書き込み可能
`consentSettings.consentType.map[]`	`list`	このマップパラメータのパラメータ（一意のキーが必要）。	書き込み可能
`consentSettings.consentType.type`	`string`	パラメータの型。有効な値は次のとおりです。 `boolean`: ブール値（「true」または「false」） `integer`: 64 ビット符号付き整数値（10 進数） `list`: パラメータのリスト `map`: パラメータのマップ `template`: 任意のテキスト。変数参照も使用可能（文字列以外の型を返す変数参照にも対応） `trigger_reference`: トリガーを表す値（トリガー ID） `tag_reference`: タグを表す値（タグ名）有効な値は次のとおりです。 "`boolean`" "`integer`" "`list`" "`map`" "`tagReference`" "`template`" "`triggerReference`" "`typeUnspecified`"	書き込み可能
`consentSettings.consentType.value`	`string`	指定された型のパラメータ値（「」などの変数参照も使用可）。	書き込み可能
`containerId`	`string`	GTM コンテナ ID。
`fingerprint`	`string`	保存時に計算された GTM タグのフィンガープリント。この値は、タグが変更されるたびに再計算されます。
`firingRuleId[]`	`list`	配信ルール ID。リストにあるルールのいずれかが true で、`blockingRuleIds` のすべてが false の場合（指定されている場合）は、タグが配信されます。	書き込み可能
`firingTriggerId[]`	`list`	配信トリガー ID。リストにあるトリガーのいずれかが true で、`blockingTriggerIds` のすべてが false の場合（指定されている場合）は、タグが配信されます。	書き込み可能
`liveOnly`	`boolean`	true に設定すると、このタグは実際の環境でのみ配信されます（プレビューモードやデバッグモードでは配信されません）。	書き込み可能
`monitoringMetadata`	`nested object`	タグのモニタリング対象となるイベントデータに含めるタグメタデータの Key-Value ペアのマップ。備考: このパラメータは `MAP` 型にする必要があります。マップ内の各パラメータは `TEMPLATE` 型ですが、変数参照を含めることはできません。	書き込み可能
`monitoringMetadata.isWeakReference`	`boolean`	参照型のパラメータが強参照または弱参照かどうか。変換でのみ使用できます。	書き込み可能
`monitoringMetadata.key`	`string`	パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。	書き込み可能
`monitoringMetadata.list[]`	`list`	このリストパラメータのパラメータ（キーは無視されます）。	書き込み可能
`monitoringMetadata.map[]`	`list`	このマップパラメータのパラメータ（一意のキーが必要）。	書き込み可能
`monitoringMetadata.type`	`string`	パラメータの型。有効な値は次のとおりです。 `boolean`: ブール値（「true」または「false」） `integer`: 64 ビット符号付き整数値（10 進数） `list`: パラメータのリスト `map`: パラメータのマップ `template`: 任意のテキスト。変数参照も使用可能（文字列以外の型を返す変数参照にも対応） `trigger_reference`: トリガーを表す値（トリガー ID） `tag_reference`: タグを表す値（タグ名）有効な値は次のとおりです。 "`boolean`" "`integer`" "`list`" "`map`" "`tagReference`" "`template`" "`triggerReference`" "`typeUnspecified`"	書き込み可能
`monitoringMetadata.value`	`string`	指定された型のパラメータ値（「」などの変数参照も使用可）。	書き込み可能
`monitoringMetadataTagNameKey`	`string`	空でない場合、指定されたキーを使ってタグの表示名がモニタリングメタデータマップに含められます。	書き込み可能
`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 相対パス。
`paused`	`boolean`	タグが一時停止になっているかどうかを示します。一時停止中のタグは配信されません。	書き込み可能
`priority`	`nested object`	ユーザー定義のタグの優先度（数値）。タグは優先度の高い順に非同期で配信されます。優先度の数値が最も大きいタグが最初に配信されます。タグの優先度は正または負の値で指定できます。デフォルト値は 0 です。	書き込み可能
`priority.isWeakReference`	`boolean`	参照型のパラメータが強参照または弱参照かどうか。変換でのみ使用できます。	書き込み可能
`priority.key`	`string`	パラメータを一意に識別する名前付きキー。トップレベルのパラメータとマップ値では必須となります。リスト値では無視されます。	書き込み可能
`priority.list[]`	`list`	このリストパラメータのパラメータ（キーは無視されます）。	書き込み可能
`priority.map[]`	`list`	このマップパラメータのパラメータ（一意のキーが必要）。	書き込み可能
`priority.type`	`string`	パラメータの型。有効な値は次のとおりです。 `boolean`: ブール値（「true」または「false」） `integer`: 64 ビット符号付き整数値（10 進数） `list`: パラメータのリスト `map`: パラメータのマップ `template`: 任意のテキスト。変数参照も使用可能（文字列以外の型を返す変数参照にも対応） `trigger_reference`: トリガーを表す値（トリガー ID） `tag_reference`: タグを表す値（タグ名）有効な値は次のとおりです。 "`boolean`" "`integer`" "`list`" "`map`" "`tagReference`" "`template`" "`triggerReference`" "`typeUnspecified`"	書き込み可能
`priority.value`	`string`	指定された型のパラメータ値（「」などの変数参照も使用可）。	書き込み可能
`scheduleEndMs`	`long`	タグをスケジュール設定する終了タイムスタンプ（ミリ秒単位）。	書き込み可能
`scheduleStartMs`	`long`	タグをスケジュール設定する開始タイムスタンプ（ミリ秒単位）。	書き込み可能
`setupTag[]`	`list`	設定タグのリスト。現在は 1 つのみ許可されます。
`setupTag[].stopOnSetupFailure`	`boolean`	true の場合は、設定タグが正常に配信された場合に限りメインのタグが配信されます。false の場合は、設定タグの配信状況に関係なくメインのタグが配信されます。
`setupTag[].tagName`	`string`	設定タグの名前。
`tagFiringOption`	`string`	このタグの配信オプションです。有効な値は次のとおりです。 "`oncePerEvent`" "`oncePerLoad`" "`tagFiringOptionUnspecified`" "`unlimited`"
`tagId`	`string`	GTM タグを一意に識別するタグ ID。
`tagManagerUrl`	`string`	タグマネージャーの管理画面への自動生成リンク。
`teardownTag[]`	`list`	ティアダウンタグのリスト。現在は 1 つのみ許可されます。
`teardownTag[].stopTeardownOnFailure`	`boolean`	true の場合は、メインのタグが正常に配信された場合に限りティアダウンタグが配信されます。false の場合は、メインのタグの配信状況に関係なくティアダウンタグが配信されます。
`teardownTag[].tagName`	`string`	ティアダウンタグの名前。
`type`	`string`	GTM タグのタイプ。	書き込み可能
`workspaceId`	`string`	GTM ワークスペース ID。

Methods

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