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

Относительный путь API тега GTM.

accountId

string

Идентификатор аккаунта GTM.

containerId

string

Идентификатор контейнера GTM.

workspaceId

string

Идентификатор рабочей области GTM.

tagId

string

Идентификатор тега однозначно идентифицирует тег 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

Идентификаторы триггеров активации. Тег сработает, когда любой из перечисленных триггеров сработает и все его

blockingTriggerIds

(если таковые указаны) являются ложными.

blockingTriggerId[]

string

Блокировка идентификаторов триггеров. Если какой-либо из перечисленных триггеров имеет значение true, тег не сработает.

setupTag[]

object ( SetupTag )

Список тегов настройки. В настоящее время мы разрешаем только один.

teardownTag[]

object ( TeardownTag )

Список тегов удаления. В настоящее время мы разрешаем только один.

parentFolderId

string

Идентификатор родительской папки.

tagFiringOption

enum ( TagFiringOption )

Возможность активировать этот тег.

tagManagerUrl

string

Автоматически созданная ссылка на пользовательский интерфейс диспетчера тегов

paused

boolean

Указывает, приостановлен ли тег, что предотвращает активацию тега.

monitoringMetadata

object ( Parameter )

Карта пар ключ-значение метаданных тега, которые будут включены в данные событий для мониторинга тегов. Примечания:

  • Этот параметр должен быть типа

    MAP

    .

  • Каждый параметр на карте имеет тип

    TEMPLATE

    , однако не может содержать ссылки на переменные.

monitoringMetadataTagNameKey

string

Если оно не пустое, отображаемое имя тега будет включено в карту метаданных мониторинга с использованием указанного ключа.

consentSettings

object ( ConsentSetting )

Настройки согласия тега.

Тег настройки

Представляет ссылку на тег, который срабатывает перед другим тегом для настройки зависимостей.

JSON-представление 
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
Поля
tagName

string

Имя тега настройки.

stopOnSetupFailure

boolean

Если это правда, активировать основной тег тогда и только тогда, когда тег настройки срабатывает успешно. Если значение равно false, активировать основной тег независимо от статуса активации тега настройки.

TeardownTag

Представляет тег, который срабатывает после другого тега, чтобы разорвать зависимости.

JSON-представление 
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
Поля
tagName

string

Имя тега удаления.

stopTeardownOnFailure

boolean

Если это правда, активировать тег демонтажа тогда и только тогда, когда основной тег срабатывает успешно. Если значение равно false, активировать тег удаления независимо от статуса активации основного тега.

ТегФирингОпция

Перечисления
tagFiringOptionUnspecified
unlimited Тег может быть активирован несколько раз за одно событие.
oncePerEvent Тег может активироваться только для каждого события, но может запускаться несколько раз за загрузку (например, загрузку приложения или страницы).
oncePerLoad Тег может активироваться только при каждой загрузке (например, при загрузке приложения или страницы).

Настройка согласия

JSON-представление 
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
Поля
consentStatus

enum ( ManualConsentOption )

Статус согласия тега. Если установлено значение NEEDED, среда выполнения будет проверять соответствие типов согласия, указанных в

consentType

поле было предоставлено.

consentType

object ( Parameter )

Тип согласия, которое необходимо проверить во время активации тега, если согласие находится в состоянии НЕОБХОДИМО. Этот параметр должен иметь тип

LIST

где каждый элемент списка имеет тип

STRING

.

МануалКонсентвариант

Перечисления
notSet Значение по умолчанию, если пользователь не указал для него никаких настроек.
notNeeded Тег не требует дополнительных настроек согласия.
needed Тег требует дополнительных настроек согласия.

Методы

create

 Создает тег GTM.

delete

 Удаляет тег GTM.

get

 Получает тег GTM.

list

 Перечисляет все теги GTM контейнера.

revert

 Отменяет изменения тега GTM в рабочей области GTM.

update

 Обновляет тег GTM.