API Reference

Esta referência da API está organizada por tipo de recurso. Cada tipo de recurso tem uma ou mais representações de dados e um ou mais métodos.

Tipos de recurso

  1. Accounts
  2. Variáveis incorporadas
  3. Clientes
  4. Contêineres
  5. Destinos
  6. Ambientes
  7. Pastas
  8. Configuração da tag do Google
  9. Tags
  10. Modelos
  11. Transformações
  12. Gatilhos
  13. Permissões do usuário
  14. Variáveis
  15. Cabeçalhos de versão
  16. Versões
  17. Espaços de trabalho
  18. Zonas

Contas

Para detalhes sobre o recurso Accounts, consulte a página Representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
get GET  /path Recebe um Account do GTM.
list GET  /accounts Lista todos os Accounts do GTM aos quais um usuário tem acesso.
update PUT  /path Atualiza um Account do GTM.

Built-In Variables

Para detalhes sobre Built-In Variables, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/built_in_variables Cria um ou mais Built-In Variables do GTM.
delete DELETE  /path Exclui um ou mais Built-In Variables do GTM.
list GET  /+parent/built_in_variables Lista todos os Built-In Variables ativados de um Container do GTM.
revert POST  /+path/built_in_variables:revert Reverte as mudanças de um Built-In Variable do GTM em um Workspace do GTM.

Clientes

Para saber mais sobre o recurso Clients, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/clients Cria um cliente do GTM.
delete DELETE  /path Exclui um cliente do GTM.
get GET  /path Recebe um cliente do GTM.
list GET  /+parent/clients Lista todos os clientes do GTM de um espaço de trabalho do contêiner do GTM.
revert POST  /+path:revert Reverte as mudanças para um cliente do GTM em um espaço de trabalho do GTM.
update PUT  /path Atualiza um cliente do GTM.

Contêineres

Para detalhes sobre Containers, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
combine POST  /+path:combine Combina contêineres.
create POST  /+parent/containers Cria um Container.
delete DELETE  /path Exclui um Container.
get GET  /path Recebe um Container.
list GET  /+parent/containers Lista todos os contêineres que pertencem a uma conta do GTM.
pesquisa GET  /accounts/containers:lookup Procura um contêiner por ID de destino.
move_tag_id POST  /+path:move_tag_id Mova o ID da tag de um contêiner.
snippet GET  /+path:snippet Recebe o snippet de inclusão de tag de um Container.
update PUT  /path Atualiza um contêiner.

Destinos

Para saber mais sobre o recurso Destinations, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
get GET  /path Recebe um destino.
link POST  /+parent/destinations:link Adiciona um destino a esse contêiner e o remove do contêiner ao qual está vinculado no momento.
list GET  /+parent/destinations Lista todos os destinos vinculados a um Container do GTM.

Ambientes

Para detalhes sobre Environments, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/environments Cria um Environment do GTM.
delete DELETE  /path Exclui um Environment do GTM.
get GET  /path Recebe um Environment do GTM.
list GET  /+parent/environments Lista todos os Environments do GTM de um Container do GTM.
reauthorize POST  /+path:reauthorize Gera novamente o código de autorização de um Environment do GTM.
update PUT  /path Atualiza um Environment do GTM.

Pastas

Para detalhes sobre Folders, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/folders Cria um Folder do GTM.
delete DELETE  /path Exclui um Folder do GTM.
entities POST  /+path:entities Lista todas as entidades em um Folder do GTM.
get GET  /path Recebe um Folder do GTM.
list GET  /+parent/folders Lista todos os Folders do GTM de um Container.
move_entities_to_folder POST  /+path:move_entities_to_folder Move entidades para um Folder do GTM. Se {folder_id} no caminho da solicitação for igual a 0, as entidades serão removidas da pasta a que pertencem atualmente.
revert POST  /+path:revert Reverte as alterações em um Folder do GTM em um Workspace do GTM.
update PUT  /path Atualiza uma pasta do GTM.

Configuração da tag do Google

Para ver detalhes sobre o recurso de configuração da tag do Google, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/gtag_config Cria uma configuração de tag do Google.
excluir DELETE  /path Exclui uma configuração de tag do Google.
get GET  /path Recebe uma configuração de tag do Google.
list GET  /+parent/gtag_config Lista todas as configurações da tag do Google em um contêiner.
update PUT  /path Atualiza uma configuração de tag do Google.

Tags

Para detalhes sobre Tags, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/tags Cria um Tag do GTM.
delete DELETE  /path Exclui um Tag do GTM.
get GET  /path Recebe um Tag do GTM.
list GET  /+parent/tags Lista todos os Tags do GTM de um Container.
revert POST  /+path:revert Reverte as alterações em um Tag do GTM em um Workspace do GTM.
update PUT  /path Atualiza um Tag do GTM.

Modelos

Para saber mais sobre Templates, consulte a página de representação de recursos.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/templates Cria um Custom Template do GTM.
delete DELETE  /path Exclui um Template do GTM.
get GET  /path Recebe um Template do GTM.
list GET  /+parent/templates Lista todos os Templates do GTM de um Workspace do Container do GTM.
revert POST  /+path:revert Reverte as alterações de um Template do GTM em um Workspace do GTM.
update PUT  /path Atualiza um Template do GTM.

Transformações

Para detalhes sobre o recurso Transformations, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/transformations Cria uma transformação do GTM.
excluir DELETE  /path Exclui uma transformação do GTM.
get GET  /path Recebe uma Transformation do GTM.
list GET  /+parent/transformations Lista todas as Transformations do GTM de um workspace do Container do GTM.
revert POST  /+path:revert Reverte as alterações de uma transformação do GTM em um espaço de trabalho do GTM.
update PUT  /path Atualiza uma transformação do GTM.

Gatilhos

Para detalhes sobre Triggers, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/triggers Cria um Trigger do GTM.
delete DELETE  /path Exclui um Trigger do GTM.
get GET  /path Recebe um Trigger do GTM.
list GET  /+parent/triggers Lista todos os Triggers do GTM de um Container.
revert POST  /+path:revert Reverte as alterações em um Trigger do GTM em um Workspace do GTM.
update PUT  /path Atualiza um Trigger do GTM.

User Permissions

Para detalhes sobre User Permissions, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/user_permissions Cria o acesso ao Account e ao Container de um usuário.
delete DELETE  /path Remove um usuário da conta e revoga o acesso a ela e a todos os contêineres relacionados.
get GET  /path Recebe acesso ao Account e Container de um usuário.
list GET  /+parent/user_permissions Lista todos os usuários que têm acesso à conta e que receberam acesso de usuário ao Account e ao Container.
update PUT  /path Atualiza o acesso ao Account e ao Container de um usuário.

Variáveis

Para detalhes sobre Variables, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/variables Cria um Variable do GTM.
delete DELETE  /path Exclui um Variable do GTM.
get GET  /path Recebe um Variable do GTM.
list GET  /+parent/variables Lista todos os Variables do GTM de um Container.
revert POST  /+path:revert Reverte as alterações em um Variable do GTM em Workspace do GTM.
update PUT  /path Atualiza um Variable do GTM.

Version Headers

Para detalhes sobre Version Headers, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
mais recente GET  /+parent/version_headers:latest Recebe o cabeçalho da versão mais recente do contêiner.
list GET  /+parent/version_headers Lista todos os Container Versions de um Container do GTM.

Versions

Para detalhes sobre Versions, consulte a página representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
delete DELETE  /path Exclui um Container Version.
get GET  /path Recebe um Container Version.
live GET  /+parent/versions:live Recebe a versão atual do contêiner (ou seja, a versão publicada).
publish POST  /+path:publish Publica um Container Version.
set_latest POST  /+path:set_latest Define a versão mais recente usada para sincronizar os espaços de trabalho ao detectar conflitos e erros.
undelete POST  /+path:undelete Cancela a exclusão de um Container Version.
update PUT  /path Atualiza um Container Version.

Workspaces

Para detalhes sobre Workspaces, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/workspaces Cria um Workspace.
create_version POST  /+path:create_version Cria um Container Version a partir das entidades presentes no espaço de trabalho, exclui o espaço de trabalho e define a versão de contêiner de base para a versão recém-criada.
delete DELETE  /path Exclui um Workspace
get GET  /path Recebe um Workspace.
getStatus GET  /+path/status Localiza entidades conflitantes e modificadas no espaço de trabalho.
list GET  /+parent/workspaces Lista todos os Workspaces que pertencem a um Container do GTM.
quick_preview POST  /+path:quick_preview Exibe um espaço de trabalho criando uma versão de contêiner falsa de todas as entidades no espaço de trabalho fornecido.
resolve_conflict POST  /+path:resolve_conflict Soluciona um conflito de integração de uma entidade de espaço de trabalho por meio de uma atualização para a entidade correta enviada na solicitação.
sync POST  /+path:sync Sincroniza um espaço de trabalho com a versão mais recente do contêiner atualizando todas as entidades de espaço de trabalho não modificadas e exibindo conflitos para aquelas modificadas.
update PUT  /path Atualiza um Workspace.

Zones

Para saber mais sobre Zones, consulte a página de representação de recursos.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/tagmanager/v2, a menos que especificado de outra forma
create POST  /+parent/zones Cria um Zone do GTM.
delete DELETE  /path Exclui um Zone do GTM.
get GET  /path Recebe um Zone do GTM.
list GET  /+parent/zones Lista todos os Zones do GTM de um Workspace do Container do GTM.
revert POST  /+path:revert Reverte as alterações de um Zone do GTM em um Workspace do GTM.
update PUT  /path Atualiza uma zona do GTM.