Requer autorização
Cria um acionador do GTM. Faça um teste agora ou veja um exemplo.
Solicitação
Solicitação HTTP
POST https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/triggers
Parâmetros
Nome do parâmetro | Valor | Descrição |
---|---|---|
Parâmetros de caminho | ||
accountId |
string |
Código do Account do GTM. |
containerId |
string |
Código do contêiner do GTM. |
Autorização
Essa solicitação requer uma autorização com o escopo a seguir (mais informações sobre autenticação e autorização).
Escopo |
---|
https://www.googleapis.com/auth/tagmanager.edit.containers |
Corpo da solicitação
No corpo da solicitação, forneça um recurso de acionadores com as seguintes propriedades:
Nome da propriedade | Valor | Descrição | Observações |
---|---|---|---|
Propriedades obrigatórias | |||
autoEventFilter[].parameter[] |
list |
Lista de parâmetros nomeados (chave/valor), dependendo do tipo de condição. Observações:
|
gravável |
autoEventFilter[].parameter[].type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
autoEventFilter[].type |
string |
Tipo de operador para essa condição.
Os valores aceitáveis são:
|
gravável |
checkValidation.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
continuousTimeMinMilliseconds.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
customEventFilter[].parameter[] |
list |
Lista de parâmetros nomeados (chave/valor), dependendo do tipo de condição. Observações:
|
gravável |
customEventFilter[].parameter[].type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
customEventFilter[].type |
string |
Tipo de operador para essa condição.
Os valores aceitáveis são:
|
gravável |
eventName.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
filter[].parameter[] |
list |
Lista de parâmetros nomeados (chave/valor), dependendo do tipo de condição. Observações:
|
gravável |
filter[].parameter[].type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
filter[].type |
string |
Tipo de operador para essa condição.
Os valores aceitáveis são:
|
gravável |
horizontalScrollPercentageList.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
interval.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
intervalSeconds.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
limit.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
maxTimerLengthSeconds.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
name |
string |
Nome de exibição do acionador. | gravável |
parameter[].type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
selector.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
totalTimeMinMilliseconds.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
type |
string |
Define o evento de camada de dados que origina esse acionador.
Os valores aceitáveis são:
|
gravável |
uniqueTriggerId.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
verticalScrollPercentageList.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
visibilitySelector.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
visiblePercentageMax.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
visiblePercentageMin.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
waitForTags.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
waitForTagsTimeout.type |
string |
Tipo de parâmetro. Os valores válidos são:
Estes são os valores aceitáveis:
|
gravável |
Propriedades opcionais | |||
autoEventFilter[] |
list |
Usado no caso de acompanhamento automático de eventos. | gravável |
autoEventFilter[].parameter[].key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
autoEventFilter[].parameter[].list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
autoEventFilter[].parameter[].map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
autoEventFilter[].parameter[].value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
checkValidation |
nested object |
Indica se as tags devem ser disparadas ou não apenas se o evento de envio de formulário ou clique no link não for cancelado por outro manipulador de eventos (por exemplo, devido a validação). Válido apenas para os acionadores de envio de formulário e clique no link. | gravável |
checkValidation.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
checkValidation.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
checkValidation.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
checkValidation.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
continuousTimeMinMilliseconds |
nested object |
Tempo contínuo mínimo visível de um acionador de visibilidade (em milissegundos). Válido apenas para o acionador de visibilidade de AMP. | gravável |
continuousTimeMinMilliseconds.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
continuousTimeMinMilliseconds.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
continuousTimeMinMilliseconds.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
continuousTimeMinMilliseconds.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
customEventFilter[] |
list |
Usado no caso de evento personalizado, que será disparado se todas as condições tiverem valor "true". | gravável |
customEventFilter[].parameter[].key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
customEventFilter[].parameter[].list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
customEventFilter[].parameter[].map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
customEventFilter[].parameter[].value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
eventName |
nested object |
Nome do evento do GTM que é disparado. Válido apenas para acionadores de timer. | gravável |
eventName.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
eventName.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
eventName.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
eventName.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
filter[] |
list |
O acionador só será disparado se todas as condições tiverem o valor "true". | gravável |
filter[].parameter[].key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
filter[].parameter[].list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
filter[].parameter[].map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
filter[].parameter[].value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
horizontalScrollPercentageList |
nested object |
Lista de valores percentuais inteiros para acionadores de rolagem. O acionador será disparado quando cada porcentagem for atingida durante uma rolagem horizontal da visualização. Válido apenas para acionadores de rolagem de AMP. | gravável |
horizontalScrollPercentageList.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
horizontalScrollPercentageList.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
horizontalScrollPercentageList.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
horizontalScrollPercentageList.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
interval |
nested object |
Tempo entre o acionamento de eventos de timer recorrentes (em milissegundos). Válido apenas para acionadores de timer. | gravável |
interval.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
interval.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
interval.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
interval.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
intervalSeconds |
nested object |
Tempo entre os eventos de timer a serem disparados (em segundos). Válido apenas para o acionador de timer de AMP. | gravável |
intervalSeconds.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
intervalSeconds.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
intervalSeconds.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
intervalSeconds.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
limit |
nested object |
Limite do número de eventos do GTM que esse acionador de timer disparará. Se nenhum limite for definido, continuaremos a disparar eventos do GTM até que o usuário saia da página. Válido apenas para acionadores de timer. | gravável |
limit.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
limit.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
limit.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
limit.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
maxTimerLengthSeconds |
nested object |
Tempo máximo para disparo de eventos de timer (em segundos). Válido apenas para o acionador de timer de AMP. | gravável |
maxTimerLengthSeconds.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
maxTimerLengthSeconds.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
maxTimerLengthSeconds.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
maxTimerLengthSeconds.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
parameter[].key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
parameter[].list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
parameter[].map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
parameter[].value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
selector |
nested object |
Seletor de CSS do acionador de cliques (ou seja, "um", "botão" etc.). Válido apenas para o acionador de cliques de AMP. | gravável |
selector.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
selector.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
selector.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
selector.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
totalTimeMinMilliseconds |
nested object |
Tempo total mínimo visível de um acionador de visibilidade (em milissegundos). Válido apenas para o acionador de visibilidade de AMP. | gravável |
totalTimeMinMilliseconds.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
totalTimeMinMilliseconds.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
totalTimeMinMilliseconds.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
totalTimeMinMilliseconds.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
uniqueTriggerId |
nested object |
Código exclusivo global do acionador que gera esse código automaticamente (um envio de formulário, clique no link ou listener de timer), se houver. Usado para que os eventos automáticos incompatíveis funcionem com o filtro de acionadores com base nos códigos de acionador. Esse valor é preenchido durante a geração do resultado, já que as tags implícitas pelos acionadores não existem antes dessa ação. Válido apenas para os acionadores de envio de formulário, clique no link e timer. | gravável |
uniqueTriggerId.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
uniqueTriggerId.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
uniqueTriggerId.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
uniqueTriggerId.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
verticalScrollPercentageList |
nested object |
Lista de valores percentuais inteiros para acionadores de rolagem. O acionador será disparado quando cada porcentagem for atingida durante uma rolagem vertical da visualização. Válido apenas para acionadores de rolagem de AMP. | gravável |
verticalScrollPercentageList.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
verticalScrollPercentageList.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
verticalScrollPercentageList.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
verticalScrollPercentageList.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
visibilitySelector |
nested object |
Seletor de CSS do acionador de visibilidade (ou seja, "#id"). Válido apenas para o acionador de visibilidade de AMP. | gravável |
visibilitySelector.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
visibilitySelector.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
visibilitySelector.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
visibilitySelector.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
visiblePercentageMax |
nested object |
Porcentagem máxima de visibilidade do acionador de visibilidade. Válido apenas para o acionador de visibilidade de AMP. | gravável |
visiblePercentageMax.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
visiblePercentageMax.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
visiblePercentageMax.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
visiblePercentageMax.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
visiblePercentageMin |
nested object |
Porcentagem mínima de visibilidade do acionador de visibilidade. Válido apenas para o acionador de visibilidade de AMP. | gravável |
visiblePercentageMin.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
visiblePercentageMin.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
visiblePercentageMin.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
visiblePercentageMin.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
waitForTags |
nested object |
Indica se devemos ou não atrasar os envios de formulários ou a abertura de links até que todas as tags sejam disparadas (impedindo que a ação padrão aconteça e simulando-a depois). Válido apenas para os acionadores de envio de formulário e clique no link. | gravável |
waitForTags.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
waitForTags.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
waitForTags.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
waitForTags.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
waitForTagsTimeout |
nested object |
Quanto tempo esperar (em milissegundos) para disparar as tags quando "waits_for_tags" acima for true . Válido apenas para os acionadores de envio de formulário e clique no link. |
gravável |
waitForTagsTimeout.key |
string |
Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. | gravável |
waitForTagsTimeout.list[] |
list |
Parâmetros dessa lista (as chaves são ignoradas). | gravável |
waitForTagsTimeout.map[] |
list |
Parâmetros desse mapa (é necessário ter chaves únicas). | gravável |
waitForTagsTimeout.value |
string |
Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. | gravável |
Resposta
Se for bem-sucedido, este método retornará um recurso de acionadores no corpo da resposta.
Exemplos
Observação: os exemplos de código disponíveis para esse método não representam todas as linguagens de programação compatíveis. Consulte a página de bibliotecas cliente para ver uma lista de linguagens compatíveis.
Java
Usa a biblioteca cliente de 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
Usa a biblioteca cliente de 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')
Confira!
Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.