Требуется авторизация
Создает триггер GTM. Попробуйте сейчас или посмотрите пример .
Запрос
HTTP-запрос
POST https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/triggers
Параметры
| Имя параметра | Ценить | Описание |
|---|---|---|
| Параметры пути | ||
accountId | string | Идентификатор аккаунта GTM. |
containerId | string | Идентификатор контейнера GTM. |
Авторизация
Этот запрос требует авторизации со следующей областью действия ( подробнее об аутентификации и авторизации читайте здесь ).
| Объем |
|---|
https://www.googleapis.com/auth/tagmanager.edit.containers |
Тело запроса
В теле запроса укажите ресурс Triggers со следующими свойствами:
| Имя свойства | Ценить | Описание | Примечания |
|---|---|---|---|
| Обязательные свойства | |||
autoEventFilter[]. parameter[] | list | Список именованных параметров (ключ/значение) в зависимости от типа условия. Примечания:
| записываемый |
autoEventFilter[].parameter[]. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
autoEventFilter[]. type | string | Тип оператора для этого условия. Приемлемые значения:
| записываемый |
checkValidation. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
continuousTimeMinMilliseconds. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
customEventFilter[]. parameter[] | list | Список именованных параметров (ключ/значение) в зависимости от типа условия. Примечания:
| записываемый |
customEventFilter[].parameter[]. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
customEventFilter[]. type | string | Тип оператора для этого условия. Приемлемые значения:
| записываемый |
eventName. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
filter[]. parameter[] | list | Список именованных параметров (ключ/значение), в зависимости от типа условия. Примечания:
| записываемый |
filter[].parameter[]. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
filter[]. type | string | Тип оператора для этого условия. Приемлемые значения:
| записываемый |
horizontalScrollPercentageList. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
interval. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
intervalSeconds. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
limit. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
maxTimerLengthSeconds. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
name | string | Отображаемое имя триггера. | записываемый |
parameter[]. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
selector. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
totalTimeMinMilliseconds. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
type | string | Определяет событие уровня данных, которое вызывает этот триггер. Приемлемые значения:
| записываемый |
uniqueTriggerId. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
verticalScrollPercentageList. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
visibilitySelector. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
visiblePercentageMax. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
visiblePercentageMin. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
waitForTags. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
waitForTagsTimeout. type | string | Тип параметра. Допустимые значения:
Приемлемые значения:
| записываемый |
| Дополнительные свойства | |||
autoEventFilter[] | list | Используется в случае автоматического отслеживания событий. | записываемый |
autoEventFilter[].parameter[]. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
autoEventFilter[].parameter[]. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
autoEventFilter[].parameter[]. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
autoEventFilter[].parameter[]. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
checkValidation | nested object | Должны ли мы активировать теги только в том случае, если событие отправки формы или нажатия ссылки не отменено каким-либо другим обработчиком событий (например, из-за проверки). Действительно только для триггеров отправки формы и клика по ссылке. | записываемый |
checkValidation. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
checkValidation. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
checkValidation. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
checkValidation. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
continuousTimeMinMilliseconds | nested object | Минимальное время непрерывной видимости триггера видимости (в миллисекундах). Действительно только для триггера видимости AMP. | записываемый |
continuousTimeMinMilliseconds. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
continuousTimeMinMilliseconds. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
continuousTimeMinMilliseconds. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
continuousTimeMinMilliseconds. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
customEventFilter[] | list | Используется в случае пользовательского события, которое запускается, если все условия истинны. | записываемый |
customEventFilter[].parameter[]. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
customEventFilter[].parameter[]. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
customEventFilter[].parameter[]. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
customEventFilter[].parameter[]. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
eventName | nested object | Имя запускаемого события GTM. Действительно только для триггеров таймера. | записываемый |
eventName. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
eventName. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
eventName. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
eventName. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
filter[] | list | Триггер сработает только в том случае, если все условия верны. | записываемый |
filter[].parameter[]. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
filter[].parameter[]. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
filter[].parameter[]. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
filter[].parameter[]. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
horizontalScrollPercentageList | nested object | Список целочисленных процентных значений для триггеров прокрутки. Триггер сработает при достижении каждого процента при горизонтальной прокрутке представления. Действительно только для триггеров прокрутки AMP. | записываемый |
horizontalScrollPercentageList. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
horizontalScrollPercentageList. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
horizontalScrollPercentageList. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
horizontalScrollPercentageList. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
interval | nested object | Время между запуском повторяющихся событий таймера (в миллисекундах). Действительно только для триггеров таймера. | записываемый |
interval. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
interval. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
interval. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
interval. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
intervalSeconds | nested object | Время между срабатыванием событий таймера (в секундах). Действительно только для триггера таймера AMP. | записываемый |
intervalSeconds. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
intervalSeconds. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
intervalSeconds. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
intervalSeconds. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
limit | nested object | Ограничение количества событий GTM, которые будет активировать этот триггер таймера. Если ограничение не установлено, мы продолжим генерировать события GTM до тех пор, пока пользователь не покинет страницу. Действительно только для триггеров таймера. | записываемый |
limit. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
limit. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
limit. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
limit. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
maxTimerLengthSeconds | nested object | Максимальное время для запуска событий таймера (в секундах). Действительно только для триггера таймера AMP. | записываемый |
maxTimerLengthSeconds. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
maxTimerLengthSeconds. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
maxTimerLengthSeconds. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
maxTimerLengthSeconds. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
parameter[]. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
parameter[]. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
parameter[]. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
parameter[]. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
selector | nested object | CSS-селектор триггера клика (т. е. «a», «кнопка» и т. д.). Действительно только для триггера AMP Click. | записываемый |
selector. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
selector. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
selector. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
selector. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
totalTimeMinMilliseconds | nested object | Минимальное общее время видимости триггера видимости (в миллисекундах). Действительно только для триггера видимости AMP. | записываемый |
totalTimeMinMilliseconds. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
totalTimeMinMilliseconds. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
totalTimeMinMilliseconds. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
totalTimeMinMilliseconds. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
uniqueTriggerId | nested object | Глобальный уникальный идентификатор триггера, который автоматически генерирует это (отправка формы, щелчок по ссылке или прослушиватель таймера), если таковой имеется. Используется для совместной работы несовместимых автоматических событий с фильтрацией триггеров на основе идентификаторов триггеров. Это значение заполняется во время генерации выходных данных, поскольку до этого момента теги, подразумеваемые триггерами, не существуют. Действительно только для триггеров отправки формы, щелчка по ссылке и таймера. | записываемый |
uniqueTriggerId. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
uniqueTriggerId. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
uniqueTriggerId. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
uniqueTriggerId. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
verticalScrollPercentageList | nested object | Список целочисленных процентных значений для триггеров прокрутки. Триггер сработает при достижении каждого процента при вертикальной прокрутке представления. Действительно только для триггеров прокрутки AMP. | записываемый |
verticalScrollPercentageList. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
verticalScrollPercentageList. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
verticalScrollPercentageList. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
verticalScrollPercentageList. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
visibilitySelector | nested object | CSS-селектор триггера видимости (т. е. «#id»). Действительно только для триггера видимости AMP. | записываемый |
visibilitySelector. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
visibilitySelector. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
visibilitySelector. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
visibilitySelector. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
visiblePercentageMax | nested object | Видимость вызывает максимальный процент видимости. Действительно только для триггера видимости AMP. | записываемый |
visiblePercentageMax. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
visiblePercentageMax. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
visiblePercentageMax. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
visiblePercentageMax. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
visiblePercentageMin | nested object | Видимость триггера минимального процента видимости. Действительно только для триггера видимости AMP. | записываемый |
visiblePercentageMin. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
visiblePercentageMin. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
visiblePercentageMin. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
visiblePercentageMin. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
waitForTags | nested object | Следует ли нам отложить отправку формы или открытие ссылки до тех пор, пока не сработают все теги (путем предотвращения действия по умолчанию и последующей имитации действия по умолчанию). Действительно только для триггеров отправки формы и клика по ссылке. | записываемый |
waitForTags. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
waitForTags. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
waitForTags. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
waitForTags. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
waitForTagsTimeout | nested object | Как долго ждать (в миллисекундах) срабатывания тегов, когда значение параметра waits_for_tags выше равно true . Действительно только для триггеров отправки формы и клика по ссылке. | записываемый |
waitForTagsTimeout. key | string | Именованный ключ, который однозначно идентифицирует параметр. Требуется для параметров верхнего уровня, а также значений карты. Игнорируется для значений списка. | записываемый |
waitForTagsTimeout. list[] | list | Параметры этого списка параметров (ключи будут игнорироваться). | записываемый |
waitForTagsTimeout. map[] | list | Параметры этого параметра карты (должны иметь ключи; ключи должны быть уникальными). | записываемый |
waitForTagsTimeout. value | string | Значение параметра (может содержать ссылки на переменные, такие как «») в соответствии с указанным типом. | записываемый |
Ответ
В случае успеха этот метод возвращает ресурс Triggers в теле ответа.
Примеры
Примечание. Примеры кода, доступные для этого метода, не представляют все поддерживаемые языки программирования (список поддерживаемых языков см. на странице клиентских библиотек ).
Джава
Использует клиентскую библиотеку Java .
/*
* Note: This code assumes you have an authorized tagmanager service object.
*/
/*
* This request creates a new trigger for the authorized user.
*/
// Create the condition parameters objects.
Parameter arg0 = new Parameter();
arg0.setType("template");
arg0.setKey("arg0");
arg0.setValue("{{Page URL}}");
Parameter arg1 = new Parameter();
arg1.setType("template");
arg1.setKey("arg1");
arg1.setValue("timed.html");
// Create the auto event condition object.
Condition condition = new Condition();
condition.setType("contains");
condition.setParameter(Arrays.asList(arg0, arg1));
// Create the event parameter.
Parameter eventName = new Parameter();
eventName.setType("template");
eventName.setValue("gtm.timer");
// Create the interval parameter.
Parameter interval = new Parameter();
interval.setType("template");
interval.setValue("10000");
// Create the limit parameter.
Parameter limit = new Parameter();
limit.setType("template");
limit.setValue("10");
// Create the trigger object.
Trigger trigger = new Trigger();
trigger.setName("Timer Trigger");
trigger.setType("timer");
trigger.setAutoEventFilter(Arrays.asList(condition));
trigger.setEventName(eventName);
trigger.setInterval(interval);
trigger.setLimit(limit);
try {
Trigger response = tagmanager.accounts().containers().
triggers().create("123456", "54321", trigger).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 the response object.
* The following code shows how to access the created Id and Fingerprint.
*/
System.out.println("Trigger Id = " + response.getTriggerId());
System.out.println("Trigger Fingerprint = " + response.getFingerprint());
Питон
Использует клиентскую библиотеку Python .
# Note: This code assumes you have an authorized tagmanager service object.
# This request creates a new trigger.
try:
response = tagmanager.accounts().containers().triggers().create(
accountId='123456',
containerId='54321',
body={
'name': 'Timed trigger',
'type': 'timer',
'autoEventFilter': [
{
'type': 'contains',
'parameter': [
{
'type': 'template',
'key': 'arg0',
'value': '{{Page URL}}'
},
{
'type': 'template',
'key': 'arg1',
'value': 'timed.html'
}
]
}
],
'eventName': {
'type': 'template',
'value': 'gtm.timer'
},
'interval': {
'type': 'template',
'value': '10000'
},
'limit': {
'type': 'template',
'value': '10'
}
}
).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 response object.
# The following code shows how to access the created id and fingerprint.
print 'Trigger Id = %s' % response.get('triggerId')
print 'Trigger Fingerprint = %s' % response.get('fingerprint')
Попробуй это!
Используйте API-интерфейс ниже, чтобы вызвать этот метод для реальных данных и просмотреть ответ.