Благодарим за интерес к предварительной версии документации о новой платформе для тегов Google. Этот сайт проходит общедоступное бета-тестирование. Оставить отзыв

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)
    ]
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    }
  ],
  "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)
    ]
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    "consentStatus": string,
    "consentType": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    }
  }
}
Имя свойства Ценность Описание Заметки
accountId string Идентификатор учетной записи GTM.
blockingRuleId[] list Идентификаторы правил блокировки. Если какое-либо из перечисленных правил оценивается как истинное, тег не сработает. доступный для записи
blockingTriggerId[] list Блокировка идентификаторов триггеров. Если какой-либо из перечисленных триггеров оценивается как true, тег не сработает. доступный для записи
consentSettings nested object Настройки согласия тега. доступный для записи
consentSettings. consentStatus string Статус согласия тега. Если установлено значение consent_type , среда выполнения проверит, были ли предоставлены типы согласия, указанные в поле согласия_типа.

Допустимые значения:
  • " needed "
  • " notNeeded "
  • " notSet "
consentSettings. consentType nested object Тип согласия для проверки во время активации тега, если согласие находится в состоянии НЕОБХОДИМО. Этот параметр должен иметь тип LIST , где каждый элемент списка имеет тип STRING .
consentSettings.consentType. key string Именованный ключ, однозначно идентифицирующий параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. доступный для записи
consentSettings.consentType. list[] list Параметры этого параметра списка (ключи будут игнорироваться). доступный для записи
consentSettings.consentType. map[] list Параметры этого параметра карты (должны быть ключи; ключи должны быть уникальными). доступный для записи
consentSettings.consentType. type string Тип параметра. Допустимые значения:
  • boolean : значение представляет собой логическое значение, представленное как «истина» или «ложь».
  • integer : значение представляет собой 64-битное целое число со знаком в базе 10.
  • list : должен быть указан список параметров
  • map : необходимо указать карту параметров
  • template : значение представляет собой любой текст; это может включать ссылки на переменные (даже ссылки на переменные, которые могут возвращать нестроковые типы)
  • trigger_reference : значение представляет триггер, представленный как идентификатор триггера.
  • tag_reference : значение представляет собой тег, представленный в виде имени тега.


Допустимые значения:
  • " boolean "
  • " integer "
  • " list "
  • " map "
  • " tagReference "
  • " template "
  • " triggerReference "
  • " typeUnspecified "
доступный для записи
consentSettings.consentType. value string Значение параметра (может содержать ссылки на переменные, такие как "") в соответствии с указанным типом. доступный для записи
containerId string Идентификатор контейнера GTM.
fingerprint string Отпечаток тега GTM, вычисленный во время хранения. Это значение пересчитывается каждый раз при изменении тега.
firingRuleId[] list Идентификаторы правил активации. Тег сработает, если любое из перечисленных правил истинно, а все его blockingRuleIds (если они указаны) ложны. доступный для записи
firingTriggerId[] list Идентификаторы триггеров срабатывания. Тег сработает, когда любой из перечисленных триггеров будет истинным, а все его blockingTriggerIds (если они указаны) ложными. доступный для записи
liveOnly boolean Если установлено значение true, этот тег будет активироваться только в реальной среде (например, не в режиме предварительного просмотра или отладки). доступный для записи
monitoringMetadata nested object Карта пар ключ-значение метаданных тегов, которые должны быть включены в данные о событиях для мониторинга тегов. Заметки:
  • Этот параметр должен быть типа MAP .
  • Каждый параметр на карте имеет тип TEMPLATE , однако не может содержать ссылки на переменные.
доступный для записи
monitoringMetadata. key string Именованный ключ, однозначно идентифицирующий параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. доступный для записи
monitoringMetadata. list[] list Параметры этого параметра списка (ключи будут игнорироваться). доступный для записи
monitoringMetadata. map[] list Параметры этого параметра карты (должны быть ключи; ключи должны быть уникальными). доступный для записи
monitoringMetadata. type string Тип параметра. Допустимые значения:
  • boolean : значение представляет собой логическое значение, представленное как «истина» или «ложь».
  • integer : значение представляет собой 64-битное целое число со знаком в базе 10.
  • list : должен быть указан список параметров
  • map : необходимо указать карту параметров
  • template : значение представляет собой любой текст; это может включать ссылки на переменные (даже ссылки на переменные, которые могут возвращать нестроковые типы)
  • trigger_reference : значение представляет триггер, представленный как идентификатор триггера.
  • tag_reference : значение представляет собой тег, представленный в виде имени тега.


Допустимые значения:
  • " boolean "
  • " integer "
  • " list "
  • " map "
  • " tagReference "
  • " template "
  • " triggerReference "
  • " typeUnspecified "
доступный для записи
monitoringMetadata. value string Значение параметра (может содержать ссылки на переменные, такие как "") в соответствии с указанным типом. доступный для записи
monitoringMetadataTagNameKey string Если не пусто, отображаемое имя тега будет включено в карту метаданных мониторинга с использованием указанного ключа. доступный для записи
name string Отображаемое имя тега. доступный для записи
notes string Заметки пользователя о том, как применить этот тег в контейнере. доступный для записи
parameter[] list Параметры тега. доступный для записи
parameter[]. key string Именованный ключ, однозначно идентифицирующий параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. доступный для записи
parameter[]. list[] list Параметры этого параметра списка (ключи будут игнорироваться). доступный для записи
parameter[]. map[] list Параметры этого параметра карты (должны быть ключи; ключи должны быть уникальными). доступный для записи
parameter[]. type string Тип параметра. Допустимые значения:
  • boolean : значение представляет собой логическое значение, представленное как «истина» или «ложь».
  • integer : значение представляет собой 64-битное целое число со знаком в базе 10.
  • list : должен быть указан список параметров
  • map : необходимо указать карту параметров
  • template : значение представляет собой любой текст; это может включать ссылки на переменные (даже ссылки на переменные, которые могут возвращать нестроковые типы)
  • trigger_reference : значение представляет триггер, представленный как идентификатор триггера.
  • tag_reference : значение представляет собой тег, представленный в виде имени тега.


Допустимые значения:
  • " boolean "
  • " integer "
  • " list "
  • " map "
  • " tagReference "
  • " template "
  • " triggerReference "
  • " typeUnspecified "
доступный для записи
parameter[]. value string Значение параметра (может содержать ссылки на переменные, такие как "") в соответствии с указанным типом. доступный для записи
parentFolderId string Идентификатор родительской папки.
path string Относительный путь API тега GTM.
paused boolean Указывает, приостановлен ли тег, что предотвращает активацию тега. доступный для записи
priority nested object Определяемый пользователем числовой приоритет тега. Теги запускаются асинхронно в порядке приоритета. Теги с более высоким числовым значением срабатывают первыми. Приоритет тега может быть положительным или отрицательным значением. Значение по умолчанию — 0. доступный для записи
priority. key string Именованный ключ, однозначно идентифицирующий параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. доступный для записи
priority. list[] list Параметры этого параметра списка (ключи будут игнорироваться). доступный для записи
priority. map[] list Параметры этого параметра карты (должны быть ключи; ключи должны быть уникальными). доступный для записи
priority. type string Тип параметра. Допустимые значения:
  • boolean : значение представляет собой логическое значение, представленное как «истина» или «ложь».
  • integer : значение представляет собой 64-битное целое число со знаком в базе 10.
  • list : должен быть указан список параметров
  • map : необходимо указать карту параметров
  • template : значение представляет собой любой текст; это может включать ссылки на переменные (даже ссылки на переменные, которые могут возвращать нестроковые типы)
  • trigger_reference : значение представляет триггер, представленный как идентификатор триггера.
  • tag_reference : значение представляет собой тег, представленный в виде имени тега.


Допустимые значения:
  • " boolean "
  • " integer "
  • " list "
  • " map "
  • " tagReference "
  • " template "
  • " triggerReference "
  • " typeUnspecified "
доступный для записи
priority. value string Значение параметра (может содержать ссылки на переменные, такие как "") в соответствии с указанным типом. доступный для записи
scheduleEndMs long Отметка времени окончания в миллисекундах для планирования тега. доступный для записи
scheduleStartMs long Отметка времени начала в миллисекундах для планирования тега. доступный для записи
setupTag[] list Список тегов установки. В настоящее время мы разрешаем только один.
setupTag[]. stopOnSetupFailure boolean Если true, активировать основной тег тогда и только тогда, когда успешно активируется тег настройки. Если false, активировать основной тег независимо от статуса активации тега настройки.
setupTag[]. tagName string Имя тега установки.
tagFiringOption string Возможность активировать этот тег.

Допустимые значения:
  • " oncePerEvent "
  • " oncePerLoad "
  • " tagFiringOptionUnspecified "
  • " unlimited "
tagId string Идентификатор тега однозначно идентифицирует тег GTM.
tagManagerUrl string Автоматически сгенерированная ссылка на пользовательский интерфейс менеджера тегов
teardownTag[] list Список тегов разрыва. В настоящее время мы разрешаем только один.
teardownTag[]. stopTeardownOnFailure boolean Если true, запускать тег разрыва тогда и только тогда, когда основной тег успешно срабатывает. Если false, активировать тег разрыва независимо от статуса активации основного тега.
teardownTag[]. tagName string Имя тега разрыва.
type string Тип тега GTM. доступный для записи
workspaceId string Идентификатор рабочей области GTM.

Методы

Создайте
Создает тег GTM.
Удалить
Удаляет тег GTM.
получить
Получает тег GTM.
список
Список всех тегов GTM контейнера.
возвращаться
Отменяет изменения тега GTM в рабочей области GTM.
Обновить
Обновляет тег GTM.