Observação: este site para desenvolvedores está sendo transferido para developers.google.com/tag-platform e será redirecionado até 30 de setembro de 2021.

Variables: update

Requer autorização

Atualiza um Variable do GTM. Faça um teste ou veja um exemplo.

Solicitação

Solicitação HTTP

PUT https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/variables/variableId

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.
variableId string Código do Variable do GTM.
Parâmetros de consulta opcionais
fingerprint string Quando disponibilizada, essa impressão digital precisa corresponder àquela da variável armazenada.

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


Os valores aceitáveis são:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
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 de 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 o usuário 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 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
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 updates an existing 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().update("12345", "54321", "2", variable).execute();

} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * The results of the update method are stored in the response object.
 * The following code shows how to access the updated name and fingerprint.
 */
System.out.println("Updated Name = " + response.getName());
System.out.println("Updated Fingerprint = " + response.getFingerprint());

Python

Usa a biblioteca cliente de Python.

# Note: This code assumes you have an authorized tagmanager service object.

# This request updates an existing variable.
try:
  response = tagmanager.accounts().containers().variables().update(
      accountId='123456',
      containerId='54321',
      variableId='4',
      body={
          'name': 'updated_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 update method are stored in the response object.
# The following code shows how to access the updated name and fingerprint.
print 'Updated Name = %s' % response.get('name')
print 'Updated Fingerprint = %s' % response.get('fingerprint')

Faça um teste

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