REST Resource: accounts.containers.workspaces.tags

リソース: タグ

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

JSON 表現 
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "liveOnly": boolean,
  "priority": {
    object (Parameter)
  },
  "notes": string,
  "scheduleStartMs": string,
  "scheduleEndMs": string,
  "parameter": [
    {
      object (Parameter)
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      object (SetupTag)
    }
  ],
  "teardownTag": [
    {
      object (TeardownTag)
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": enum (TagFiringOption),
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    object (Parameter)
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    object (ConsentSetting)
  }
}
フィールド
path

string

GTM タグの API 相対パス。
accountId

string

GTM アカウント ID。
containerId

string

GTM コンテナ ID。
workspaceId

string

GTM ワークスペース ID。
tagId

string

GTM タグを一意に識別するタグ ID。
name

string

タグの表示名。
type

string

GTM タグのタイプ。
liveOnly

boolean

true に設定すると、このタグは実際の環境でのみ配信されます（プレビュー モードやデバッグモードでは配信されません）。
priority

object (Parameter)

ユーザー定義のタグの優先度（数値）。タグは優先度の高い順に非同期で配信されます。優先度の数値が最も大きいタグが最初に配信されます。タグの優先度は正または負の値で指定できます。デフォルト値は 0 です。
notes

string

コンテナでこのタグを利用する方法についてのユーザーのメモ。
scheduleStartMs

string (int64 format)

タグをスケジュール設定する開始タイムスタンプ（ミリ秒単位）。
scheduleEndMs

string (int64 format)

タグをスケジュール設定する終了タイムスタンプ（ミリ秒単位）。
parameter[]

object (Parameter)

タグのパラメータ。
fingerprint

string

保存時に計算された GTM タグのフィンガープリント。この値は、タグが変更されるたびに再計算されます。
firingTriggerId[]

string

配信トリガー ID。リストにあるトリガーのいずれかが true で、

blockingTriggerIds

（指定されている場合）が false である。
blockingTriggerId[]

string

ブロック トリガー ID。リストにあるトリガーのいずれかが true の場合、タグは配信されません。
setupTag[]

object (SetupTag)

設定タグのリスト。現在は 1 つのみ許可されます。
teardownTag[]

object (TeardownTag)

ティアダウン タグのリスト。現在は 1 つのみ許可されます。
parentFolderId

string

親フォルダ ID。
tagFiringOption

enum (TagFiringOption)

このタグの配信オプションです。
tagManagerUrl

string

タグ マネージャーの管理画面への自動生成リンク。
paused

boolean

タグが一時停止になっているかどうかを示します。一時停止中のタグは配信されません。
monitoringMetadata

object (Parameter)

タグのモニタリング対象となるイベントデータに含めるタグメタデータの Key-Value ペアのマップ。注:

  • このパラメータは

    MAP

    .

  • マップ内の各パラメータは

    TEMPLATE

    型ですが、変数参照を含めることはできません。
monitoringMetadataTagNameKey

string

空でない場合、指定されたキーを使ってタグの表示名がモニタリング メタデータ マップに含められます。
consentSettings

object (ConsentSetting)

タグの同意設定。

SetupTag

依存関係を設定するために、他のタグの前に配信されるタグへの参照を表します。

JSON 表現 
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
フィールド
tagName

string

設定タグの名前。
stopOnSetupFailure

boolean

true の場合は、設定タグが正常に配信された場合に限りメインのタグが配信されます。false の場合は、設定タグの配信状況に関係なくメインのタグが配信されます。

TeardownTag

依存関係を解除するために別のタグの後に配信されるタグを表します。

JSON 表現 
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
フィールド
tagName

string

ティアダウン タグの名前。
stopTeardownOnFailure

boolean

true の場合は、メインのタグが正常に配信された場合に限りティアダウン タグが配信されます。false の場合は、メインのタグの配信状況に関係なくティアダウン タグが配信されます。

TagFiringOption

列挙型
tagFiringOptionUnspecified
unlimited タグはイベントごとに複数回配信できます。
oncePerEvent タグはイベントごとに 1 回のみ配信されますが、読み込み（アプリの読み込みやページの読み込みなど）ごとに複数回配信できます。
oncePerLoad タグは読み込み（アプリの読み込みやページの読み込みなど）ごとに 1 回のみ配信できます。

ConsentSetting

JSON 表現 
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
フィールド
consentStatus

enum (ManualConsentOption)

タグの同意ステータス。NEEDED に設定すると、ランタイムは

consentType

フィールドが付与されている。
consentType

object (Parameter)

同意が NEEDED 状態の場合に、タグの配信時に確認する同意のタイプ。このパラメータの型は

LIST

各リストアイテムの型は

STRING

.

ManualConsentOption

列挙型
notSet ユーザーが設定を指定していない場合のデフォルト値。
notNeeded タグに追加の同意設定は必要ありません。
needed タグに追加の同意設定が必要です。

メソッド

create

 GTM タグを作成します。

delete

 GTM タグを削除します。

get

 GTM タグを取得します。

list

 コンテナのすべての GTM タグを一覧表示します。

revert

 GTM ワークスペースの GTM タグに加えた変更を元に戻します。

update

 GTM タグを更新します。