Tags: update

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

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

Запрос

HTTP-запрос

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

Параметры

Название параметра Значение Описание
Параметры пути
accountId string Идентификатор аккаунта Google Менеджера тегов.
containerId string Идентификатор контейнера Google Менеджера тегов.
tagId string Идентификатор тега Google Менеджера тегов.
Необязательные параметры запроса
fingerprint 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"
Можно редактировать
Необязательные свойства
blockingRuleId[] list Идентификаторы правил блокировки. Если какие-либо из перечисленных правил окажутся истинными, тег не сработает. Можно редактировать
blockingTriggerId[] list Идентификаторы триггеров блокировки. Если какие-либо из перечисленных триггеров окажутся истинными, тег не сработает. Можно редактировать
firingRuleId[] list Идентификаторы правил активации. Тег будет срабатывать, когда любое из перечисленных правил истинно, а все значения blockingRuleIds (если указаны) ложны. Можно редактировать
firingTriggerId[] list Идентификаторы триггеров активации. Тег будет срабатывать, когда любой из перечисленных триггеров истинен, а все значения blockingTriggerIds (если указаны) ложны. Можно редактировать
liveOnly boolean Если установлено значение true, этот тег будет срабатывать только в реальной среде (а не в режиме предварительного просмотра или отладки). Можно редактировать
notes string Пользовательские примечания о том, как этот тег должен применяться в контейнере. Можно редактировать
parameter[] list Параметры тега. Можно редактировать
parameter[].key string Именованный ключ, позволяющий однозначно идентифицировать параметр. Требуется для параметров верхнего уровня и для значений в ассоциативных массивах. Игнорируется для элементов списка. Можно редактировать
parameter[].list[] list Параметры этого параметра списка (ключи игнорируются). Можно редактировать
parameter[].map[] list Параметры этого параметра ассоциативного массива (должны содержать уникальные ключи). Можно редактировать
parameter[].value string Значение параметра. Может содержать ссылки на переменные, например "{{myVariable}}", соответствующие указанному типу. Можно редактировать
paused boolean True, если тег приостановлен. Можно редактировать
priority nested object Пользовательский числовой приоритет тега. Теги активируются асинхронно в соответствии с их приоритетом: те, у которых числовое значение приоритета выше, запускается раньше. Приоритет тега может быть выражен положительным или отрицательным значением. Значение по умолчанию – 0. Можно редактировать
priority.key string Именованный ключ, позволяющий однозначно идентифицировать параметр. Требуется для параметров верхнего уровня и для значений в ассоциативных массивах. Игнорируется для элементов списка. Можно редактировать
priority.list[] list Параметры этого параметра списка (ключи игнорируются). Можно редактировать
priority.map[] list Параметры этого параметра ассоциативного массива (должны содержать уникальные ключи). Можно редактировать
priority.value string Значение параметра. Может содержать ссылки на переменные, например "{{myVariable}}", соответствующие указанному типу. Можно редактировать
scheduleEndMs long Конечная временная метка (в миллисекундах) для выполнения тега по расписанию. Можно редактировать
scheduleStartMs long Начальная временная метка (в миллисекундах) для выполнения тега по расписанию. Можно редактировать
type string Тип тега Google Менеджера тегов. Можно редактировать

Ответ

В случае успеха этот метод возвращает ресурс Tags в теле ответа.

Примеры

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

Java

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

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

/*
 * This request updates an existing tag for the authorized user.
 */

// 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.setType("ua");
tag.setLiveOnly(false);
tag.setParameter(Arrays.asList(arg0, arg1));

try {
  Tag response = tagmanager.accounts().
      containers().tags().update("123456", "54321", "1", tag).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * The results of the update method are stored in the response object.
 * The following code shows how to access the updated name and fingerprint.
 */
System.out.println("Updated Name = " + response.getName());
System.out.println("Updated Fingerprint = " + response.getFingerprint());

Python

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

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

# This request updates an existing new container tag.
try:
  response = tagmanager.accounts().containers().tags().update(
      accountId='123456',
      containerId='54321',
      tagId='1',
      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 update method are stored in the response object.
# The following code shows how to access the updated name and fingerprint.
print 'Updated Name = %s' % response.get('name')
print 'Updated Fingerprint = %s' % response.get('fingerprint')

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

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