Variables: create

Requer autorização

Cria um Variable 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/variables

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

Nome da propriedade Valor Descrição Observações
Propriedades obrigatórias
name string Nome de exibição da variável. 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
  • trigger_reference: o valor representa um acionador, que é informado como o ID do acionador


Estes são os valores aceitáveis:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
gravável
type string Tipo de Variable do GTM. gravável
Propriedades opcionais
disablingTriggerId[] list Apenas para contêineres de dispositivos móveis: uma lista de códigos de acionadores para variáveis condicionais de desativação. A variável será ativada se um dos acionadores de ativação tiver o valor "true" e todos os acionadores de desativação apresentarem o valor "false". Tratado como um conjunto não ordenado. gravável
enablingTriggerId[] list Apenas para contêineres para dispositivos móveis: uma lista de códigos de acionadores para variáveis condicionais de ativação. A variável será ativada se um dos acionadores de ativação tiver o valor "true" e todos os acionadores de desativação apresentarem o valor "false". Tratado como um conjunto não ordenado. gravável
notes string Observações para os usuários sobre como aplicar essa variável no contêiner. gravável
parameter[] list Parâmetros da variável. 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
scheduleEndMs long Data e hora de término em milissegundos para agendar uma variável. gravável
scheduleStartMs long Data e hora de início em milissegundos para agendar uma variável. gravável

Resposta

Se for bem-sucedido, este método retornará um recurso Variables 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 variable for the authorized user.
 */

// Create the variable object.
Variable variable = new Variable();
variable.setName("randomNumber");
variable.setType("r"); // The random number type.

try {
  Variable response = tagmanager.accounts().containers().
      variables().create("123456", "54321", variable).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("Variable Id = " + response.getVariableId());
System.out.println("Variable 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 variable.
try:
  response = tagmanager.accounts().containers().variables().create(
      accountId='23732470',
      containerId='801231',
      body={
          'name': 'random_number',
          'type': 'r'
      }
  ).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 'Variable Id = %s' % response.get('variableId')
print 'Variable Fingerprint = %s' % response.get('fingerprint')

Confira!

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