REST Resource: accounts.containers.workspaces.tags

资源：代码

表示 Google 跟踪代码管理器代码。

JSON 表示法 
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    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 代码类型。
firingRuleId[]
(deprecated)

string

触发规则 ID。如果列出的任何规则为 true 且其所有

blockingRuleIds

（如果有）为 false。
blockingRuleId[]
(deprecated)

string

屏蔽规则 ID。如果列出的任何规则的计算结果为 true，将不触发代码。
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)

setup 代码列表。目前，我们仅允许有一个 teardown 代码。
teardownTag[]

object (TeardownTag)

teardown 代码列表。目前，我们仅允许有一个 teardown 代码。
parentFolderId

string

父文件夹 ID。
tagFiringOption

enum (TagFiringOption)

触发此代码的选项。
tagManagerUrl

string

自动生成的指向跟踪代码管理器界面的链接
paused

boolean

指示此代码是否已被暂停，代码被暂停后就无法触发了。
monitoringMetadata

object (Parameter)

要包含在事件数据中以进行代码监控的代码元数据的键值对映射。注意：

  • 此参数的类型必须为

    MAP

    。

  • 映射中每个参数的类型均为

    TEMPLATE

    但不得包含变量引用。
monitoringMetadataTagNameKey

string

如果为非空，系统会使用指定的键将代码的显示名称包含在监控元数据映射中。
consentSettings

object (ConsentSetting)

代码的用户意见征求设置。

SetupTag

表示对某个代码的引用，该代码会在其他代码之前触发，以便设置依赖项。

JSON 表示法 
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
字段
tagName

string

setup 代码的名称。
stopOnSetupFailure

boolean

如果为 true，则当且仅当成功触发 setup 代码时才会触发主代码。如果为 false，则无论 setup 代码触发状态为何，都会触发主代码。

TeardownTag

表示在其他代码之后触发的代码，以拆解依赖项。

JSON 表示法 
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
字段
tagName

string

teardown 代码的名称。
stopTeardownOnFailure

boolean

如果为 true，则当且仅当成功触发主代码时才会触发 teardown 代码。如果为 false，则无论主代码触发状态为何，都会触发 teardown 代码。

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 代码。