Tags: create

Требуется авторизация

Создает тег Google Менеджера тегов. Испытайте метод в действии или изучите пример.

Запрос

HTTP-запрос

POST https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/tags

Параметры

Название параметра Значение Описание
Параметры пути
accountId string Идентификатор аккаунта Менеджера тегов.
containerId string Идентификатор контейнера Менеджера тегов.

Авторизация

Этот запрос требует авторизации в указанной ниже области доступа. Подробнее об аутентификации и авторизации…

Область доступа
https://www.googleapis.com/auth/tagmanager.edit.containers

Тело запроса

В теле запроса необходимо предоставить ресурс Tags с перечисленными ниже свойствами.

Название свойства Значение Описание Примечания
Обязательные свойства
name string Отображаемое название тега. Можно перезаписывать
parameter[].type string Тип параметра. Допустимые значения:
  • boolean: логическое значение (true или false).
  • integer: 64-разрядное целое число со знаком (в десятичном виде).
  • list: список параметров.
  • map: массив параметров.
  • template: любой текст, включая ссылки на переменную (в том числе возвращающие нестроковые значения).


Допустимые значения:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
 Можно перезаписывать
priority.type string Тип параметра. Допустимые значения:
  • boolean: логическое значение (true или false).
  • integer: 64-разрядное целое число со знаком (в десятичном виде).
  • list: список параметров.
  • map: массив параметров.
  • template: любой текст, включая ссылки на переменную (в том числе возвращающие нестроковые значения).


Допустимые значения:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
 Можно перезаписывать
type string Тип тега Менеджера тегов. Можно перезаписывать
Необязательные свойства
blockingRuleId[] list Идентификаторы правил блокировки. Если какое-либо из перечисленных правил окажется истинным, тег не сработает. Можно перезаписывать
blockingTriggerId[] list Идентификаторы блокирующих триггеров. Если какой-либо из перечисленных триггеров окажется истинным, тег не сработает. Можно перезаписывать
firingRuleId[] list Идентификаторы правил активации. Тег будет срабатывать, если любое из перечисленных правил истинно, а все значения blockingRuleIds (если указаны) – ложны. Можно перезаписывать
firingTriggerId[] list Идентификаторы триггеров активации. Тег будет срабатывать, если любому из перечисленных триггеров присвоено значение true, а всем его blockingTriggerIds (если указаны) – false. Можно перезаписывать
liveOnly boolean Если свойству присвоено значение true, тег будет срабатывать только в реальной среде (а не в режиме предварительного просмотра или отладки). Можно перезаписывать
notes string Пользовательские примечания о том, как применять тег в контейнере. Можно перезаписывать
parameter[] list Параметры тега. Можно перезаписывать
parameter[].key string Именованный ключ, служащий уникальным идентификатором параметра. Требуется для параметров верхнего уровня и значений в ассоциативных массивах. Игнорируется для элементов списка. Можно перезаписывать
parameter[].list[] list Параметры этого параметра-списка (ключи игнорируются). Можно перезаписывать
parameter[].map[] list Параметры этого параметра-массива (должны содержать уникальные ключи). Можно перезаписывать
parameter[].value string Значение параметра, соответствующее указанному типу (может содержать ссылку на переменную, например "{{myVariable}}"). Можно перезаписывать
paused boolean Приостановлен ли тег (логическое значение). Можно перезаписывать
priority nested object Определенный пользователем приоритет тега (в числовом выражении). Теги активируются асинхронно в соответствии с их приоритетом: те, у которых приоритет выше, активируются раньше. Приоритет тега может быть выражен положительным или отрицательным числом. Значение по умолчанию – 0. Можно перезаписывать
priority.key string Именованный ключ, служащий уникальным идентификатором параметра. Требуется для параметров верхнего уровня и значений в ассоциативных массивах. Игнорируется для элементов списка. Можно перезаписывать
priority.list[] list Параметры этого параметра-списка (ключи игнорируются). Можно перезаписывать
priority.map[] list Параметры этого параметра-массива (должны содержать уникальные ключи). Можно перезаписывать
priority.value string Значение параметра, соответствующее указанному типу (может содержать ссылку на переменную, например "{{myVariable}}"). Можно перезаписывать
scheduleEndMs long Временная метка, соответствующая окончанию выполнения тега (в миллисекундах). Можно перезаписывать
scheduleStartMs long Временная метка, соответствующая началу выполнения тега (в миллисекундах). Можно перезаписывать

Ответ

Если метод выполнен без ошибок, он возвращает в теле ответа ресурс Tags.

Примеры

Примечание. Примеры кода для этого метода не охватывают все поддерживаемые языки программирования (их список опубликован на странице, посвященной клиентским библиотекам).

Java

Используется клиентская библиотека Java.

/*
 * Note: This code assumes you have an authorized tagmanager service object.
 */

/*
 * This request creates a new tag.
 */

// Construct the parameters.
Parameter arg0 = new Parameter();
arg0.setType("template");
arg0.setKey("trackingId");
arg0.setValue("UA-123456-1");

Parameter arg1 = new Parameter();
arg1.setType("template");
arg1.setKey("type");
arg1.setValue("TRACK_TRANSACTION");

// Construct the tag object.
Tag tag = new Tag();
tag.setName("Sample Universal Analytics Tag");
tag.setType("ua");
tag.setLiveOnly(false);
tag.setParameter(Arrays.asList(arg0, arg1));

try {
  Tag response = tagmanager.accounts().containers().
      tags().create("123456", "54321", tag).execute();

} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * The results of the create method are stored in response object.
 * The following code shows how to access the created id and fingerprint.
 */
System.out.println("Tag id = " + response.getTagId());
System.out.println("Tag Fingerprint = " + response.getFingerprint());

Python

Используется клиентская библиотека Python.

# Note: This code assumes you have an authorized tagmanager service object.

# This request creates a new container tag.
try:
  response = tagmanager.accounts().containers().tags().create(
      accountId='123456',
      containerId='54321',
      body={
          'name': 'Universal Analytics Tag',
          'type': 'ua',
          'liveOnly': False,
          'parameter': [
              {
                  'type': 'template',
                  'key': 'trackingId',
                  'value': 'UA-123456-1'
              },
              {
                  'type': 'template',
                  'key': 'type',
                  'value': 'TRACK_TRANSACTION'
              }
          ]
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

# The results of the create method are stored in the response object.
# The following code shows how to access the created id and fingerprint.
print response.get('tagId')
print response.get('fingerprint')

Практическое задание

Воспользуйтесь инструментом API Explorer, чтобы применить этот метод к реальным данным и узнать, как он работает.