Tags: create

Requer autorização

Cria um Tag do GTM. Faça um teste ou veja um exemplo.

Solicitação

Solicitação HTTP

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

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 Container 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, informe um recurso Tags com as seguintes propriedades:

Nome da propriedade Valor Descrição Observações
Propriedades obrigatórias
name string Nome de exibição da tag. gravável
parameter[].type string Tipo de parâmetro. Os valores válidos são:
  • boolean: o valor representa um booleano, exibido como "true" ou "false"
  • integer: o valor representa um número inteiro assinado com 64 bits e de formato decimal
  • list: uma lista de parâmetros precisa ser especificada
  • map: um mapa de parâmetros precisa ser especificado
  • template: o valor representa qualquer texto e inclui referências de variáveis, mesmo aquelas que podem retornar tipos que não são strings


Os valores aceitáveis são:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
gravável
priority.type string Tipo de parâmetro. Os valores válidos são:
  • boolean: o valor representa um booleano, exibido como "true" ou "false"
  • integer: o valor representa um número inteiro assinado com 64 bits e de formato decimal
  • list: uma lista de parâmetros precisa ser especificada
  • map: um mapa de parâmetros precisa ser especificado
  • template: o valor representa qualquer texto e inclui referências de variáveis, mesmo aquelas que podem retornar tipos que não são strings


Os valores aceitáveis são:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
gravável
type string Tipo de Tag do GTM. gravável
Propriedades opcionais
blockingRuleId[] list Códigos de regra de bloqueio. Se uma das regras listadas for avaliada como "true", a tag não será disparada. gravável
blockingTriggerId[] list Códigos de acionador de bloqueio. Se um dos acionadores listados for avaliado como "true", a tag não será disparada. gravável
firingRuleId[] list Códigos de regra de disparo. Uma tag é disparada quando uma das regras listadas é avaliada como "true" e todos os blockingRuleIds (se especificados) têm o valor "false". gravável
firingTriggerId[] list Códigos de acionador de disparo. Uma tag é disparada quando um dos acionadores listados é avaliado como "true" e todos os blockingTriggerIds (se especificados) têm o valor "false". gravável
liveOnly boolean Se definida como "true", essa tag só será disparada no ambiente ativo (não no modo de visualização ou depuração). gravável
notes string Observações para o usuário sobre como aplicar essa tag no contêiner. gravável
parameter[] list Parâmetros da tag. gravável
parameter[].key string Chave nomeada que identifica um parâmetro de forma exclusiva. 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 serão ignoradas). gravável
parameter[].map[] list Parâmetros desse mapa (é necessário ter chaves exclusivas). gravável
parameter[].value string Valor de um parâmetro (pode conter referências de variáveis, como "{{myVariable}}"), conforme apropriado para o tipo especificado. gravável
paused boolean Valor "true" se a tag estiver pausada. gravável
priority nested object Prioridade numérica da tag definida pelo usuário. As tags são disparadas de forma assíncrona na ordem de prioridade. Tags com valor numérico maior são disparadas primeiro. A prioridade de uma tag pode ser um valor positivo ou negativo. O valor padrão é 0. gravável
priority.key string Chave nomeada que identifica um parâmetro de forma exclusiva. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. gravável
priority.list[] list Parâmetros dessa lista (as chaves serão ignoradas). gravável
priority.map[] list Parâmetros desse mapa (é necessário ter chaves exclusivas). gravável
priority.value string Valor de um parâmetro (pode conter referências de variáveis, como "{{myVariable}}"), conforme apropriado para o tipo especificado. gravável
scheduleEndMs long Data e hora de término em milissegundos para agendar uma tag. gravável
scheduleStartMs long Data e hora de início em milissegundos para agendar uma tag. gravável

Resposta

Se for bem-sucedido, este método retornará um recurso Tags 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 tag.
 */

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

try {
  Tag response = tagmanager.accounts().containers().
      tags().create("123456", "54321", tag).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 response object.
 * The following code shows how to access the created id and fingerprint.
 */
System.out.println("Tag id = " + response.getTagId());
System.out.println("Tag 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 container tag.
try:
  response = tagmanager.accounts().containers().tags().create(
      accountId='123456',
      containerId='54321',
      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 create method are stored in the response object.
# The following code shows how to access the created id and fingerprint.
print response.get('tagId')
print response.get('fingerprint')

Faça um teste

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.