Criar acionador no Google Tag Manager, por uma API
Cria um acionador em um workspace e retorna seu triggerId. Um acionador de pageview sem filter dispara em todas as páginas. Uma condição compara uma variável, como {{Page URL}}, com um valor; as variáveis internas de cliques e formulários, como {{Click ID}}, só funcionam depois de ativadas no workspace, o que este toolkit não faz.
- Identificador
- google_tag_manager_create_trigger
A chamada
POST https://connect.reportei.com/api/tools/google_tag_manager_create_trigger/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"accountId": "<accountId>",
"containerId": "<containerId>",
"workspaceId": "<workspaceId>",
"name": "<name>",
"type": "pageview"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| accountId | string | Sim | Account id from List accounts. |
| containerId | string | Sim | Container id from List containers: the number in containerId, not the GTM- code of publicId. |
| workspaceId | string | Sim | Workspace id from List workspaces. |
| name | string | Sim | Name of the trigger in Tag Manager. |
| type | string | Sim | Event that fires the trigger: pageview, domReady or windowLoaded for page loads, customEvent for a dataLayer event, click for any element, linkClick for links only, formSubmission, historyChange, timer, scrollDepth, elementVisibility, youTubeVideo, jsError, init or consentInit.Valores: pageview, domReady, windowLoaded, customEvent, click, linkClick, formSubmission, historyChange, timer, scrollDepth, elementVisibility, youTubeVideo, jsError, init, consentInit |
| filter | array | Não | Conditions that must all be true for the trigger to fire. |
| customEventFilter | array | Não | Only customEvent: conditions on the event, such as {{_event}} equals the event name pushed to the dataLayer. |
| autoEventFilter | array | Não | Only the triggers that listen to the page, such as linkClick, formSubmission and timer: conditions that enable the listener on a page, usually on {{Page URL}}. |
| waitForTags | object | Não | Only formSubmission and linkClick: true holds the submit or the link until the tags fire. |
| waitForTagsTimeout | object | Não | Only formSubmission and linkClick: how long to hold, in milliseconds. |
| checkValidation | object | Não | Only formSubmission and linkClick: true fires the tags only if the submit or the click is not canceled by the page, such as by a failed validation. |
| eventName | object | Não | Only timer: name of the event the timer pushes. |
| interval | object | Não | Only timer: milliseconds between events. |
| limit | object | Não | Only timer: how many events to push at most. |
| parameter | array | Não | Other settings of the trigger, such as the scroll percentages of a scrollDepth trigger or the element of an elementVisibility trigger. |
| notes | string | Não | Notes about the trigger. |
Conexões possíveis
O seu cliente conecta a conta do Google Tag Manager uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/google_tag_manager, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/google_tag_manager_create_trigger. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Google Tag Manager
- Listar contasGETLista as contas do Tag Manager que o usuário pode acessar, com accountId e name. Envie nextPageToken como pageToken para ler a próxima página.
- Listar contêineresGETLista os contêineres de uma conta, com containerId, name, publicId (o código GTM- instalado no site) e usageContext, como web. Envie nextPageToken como pageToken para ler a próxima página.
- Listar workspacesGETLista os workspaces de um contêiner, com workspaceId e name. Tags e acionadores são editados em um workspace, em geral o Default Workspace, e só chegam ao site por Create version e Publish version.
- Listar tagsGETLista as tags de um workspace, com tagId, name, type, parameter, firingTriggerId e paused. Envie nextPageToken como pageToken para ler a próxima página.
- Obter tagGETRetorna uma tag com todos os seus campos, incluindo fingerprint. Update tag substitui a tag inteira, então parta desta resposta.
- Criar tagPOSTCria uma tag em um workspace. Ela só chega ao site depois de Create version e Publish version. Sem firingTriggerId a tag nunca dispara.
- Atualizar tagPUTSubstitui uma tag inteira: envie todos os campos a manter, como Get tag os retorna, com as mudanças, pois um campo omitido é apagado. Defina paused como true para parar uma tag sem excluí-la. A mudança só chega ao site depois de Create version e Publish version.
- Excluir tagDELETEExclui uma tag de um workspace. O site continua disparando a tag até que uma versão sem ela seja publicada.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
