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

代碼 ID 可用於唯一識別 GTM 代碼。
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。只要任一列出的觸發條件為真，且所有

blockingTriggerIds

(如果有指定) 為 false。
blockingTriggerId[]

string

封鎖觸發條件 ID。如果列出的任何觸發條件評估結果為 true，廣告代碼就不會觸發。
setupTag[]

object (SetupTag)

設定標記清單。目前只允許一個。
teardownTag[]

object (TeardownTag)

拆除標記清單。目前只允許一個。
parentFolderId

string

父項資料夾 ID。
tagFiringOption

enum (TagFiringOption)

觸發這個代碼的選項。
tagManagerUrl

string

自動產生的代碼管理工具 UI 連結
paused

boolean

指出代碼是否已暫停，導致代碼無法觸發。
monitoringMetadata

object (Parameter)

代碼中繼資料的鍵/值組合對應表，用於在代碼監控事件資料中加入這些資料。注意：

  • 這個參數必須是

    MAP

    。

  • 地圖中的每個參數都是類型

    TEMPLATE

    但不能包含變數參照。
monitoringMetadataTagNameKey

string

如果不為空白，系統會使用指定的鍵，將代碼顯示名稱納入監控中繼資料對應項目。
consentSettings

object (ConsentSetting)

代碼的同意聲明設定。

SetupTag

代表對 atag 的參照，該 atag 會在其他代碼之前觸發，以便設定依附元件。

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 每個事件只能觸發一次代碼，但每次載入 (例如應用程式載入或網頁載入) 可以觸發多次。
oncePerLoad 代碼只能在每次載入時觸發 (例如應用程式載入或網頁載入)。

ConsentSetting

JSON 表示法 
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
欄位
consentStatus

enum (ManualConsentOption)

代碼的同意聲明狀態。如果設為 NEEDED，執行階段會檢查

consentType

欄位。
consentType

object (Parameter)

在代碼觸發時，如果處於需要同意聲明的狀態，要檢查的同意聲明類型。這個參數必須是

LIST

其中每個清單項目的類型為

STRING

。

ManualConsentOption

列舉
notSet 使用者未指定任何設定的預設值。
notNeeded 代碼不需要任何額外的同意聲明設定。
needed 代碼需要額外的同意聲明設定。

方法

create

 建立 GTM 代碼。

delete

 刪除 GTM 代碼。

get

 取得 GTM 代碼。

list

 列出容器的所有 GTM 代碼。

revert

 將 GTM 工作區中 GTM 代碼的變更還原。

update

 更新 GTM 代碼。