Variables: update

Requiere autorización

Actualiza un recurso Variable de GTM. Pruébalo ahora o consulta un ejemplo.

Solicitud

Solicitud HTTP

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

Parámetros

Nombre de parámetro Valor Descripción
Parámetros de ruta
accountId string ID de recurso Account de GTM.
containerId string ID de recurso Container de GTM.
variableId string ID de recurso Variable de GTM.
Parámetros de consulta opcionales
fingerprint string Cuando se proporciona, esta huella digital debe coincidir con la del recurso Variable almacenado.

Autorización

Esta solicitud requiere autorización con el siguiente ámbito. Consulta más información sobre la autenticación y la autorización.

Ámbito
https://www.googleapis.com/auth/tagmanager.edit.containers

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporciona un recurso Variable con las siguientes propiedades:

Nombre de la propiedad Valor Descripción Notas
Propiedades obligatorias
name string Nombre visible del recurso Variable. editable
parameter[].type string Tipo de parámetro. Los valores válidos son los siguientes:
  • boolean: el valor representa un parámetro booleano configurado como "true" o "false".
  • integer: el valor representa un valor entero de 64 bits con signo, en base 10.
  • list: se debe especificar una lista de parámetros.
  • map: se debe especificar un mapa de parámetros.
  • template: el valor representa cualquier texto; puede incluir referencias de variables (incluso referencias de variables que podrían devolver tipos que no son de cadena).


Estos son los valores posibles:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
editable
type string Tipo del recurso Variable de GTM. editable
Propiedades opcionales
disablingTriggerId[] list Solo para contenedores móviles: lista de IDs de activadores para inhabilitar las variables condicionales; la variable se habilita si uno de los activadores de habilitación se configura como "true" y todos los activadores de inhabilitación se configuran como "false". Se trata como un conjunto desordenado. editable
enablingTriggerId[] list Solo para contenedores móviles: lista de IDs de activadores para habilitar las variables condicionales; la variable se habilita si uno de los activadores de habilitación se configura como "true" y todos los activadores de inhabilitación se configuran como "false". Se trata como un conjunto desordenado. editable
notes string Notas de usuario sobre cómo aplicar esta variable en el recurso Container. editable
parameter[] list Parámetros de la variable. editable
parameter[].key string Clave con nombre que identifica un parámetro de forma exclusiva. Es obligatoria en los parámetros de nivel superior, así como en los valores de mapa. Se ignora en los valores de lista. editable
parameter[].list[] list Parámetros de los parámetros de esta lista (las claves se ignorarán). editable
parameter[].map[] list Parámetros de los parámetros de este mapa (deben tener claves; las claves deben ser únicas). editable
parameter[].value string Valor de un parámetro (puede contener referencias de variables como "{{myVariable}}") según requiera el tipo especificado. editable
scheduleEndMs long Marca de tiempo final en milésimas de segundo para programar una variable. editable
scheduleStartMs long Marca de tiempo inicial en milésimas de segundo para programar una variable. editable

Respuesta

Si se realiza correctamente, este método devuelve un recurso Variable en el cuerpo de la respuesta.

Ejemplos

Nota: Los ejemplos de código disponibles para este método no representan todos los lenguajes de programación admitidos (consulta la página de bibliotecas de cliente para obtener una lista de los lenguajes admitidos).

Java

Utiliza la biblioteca de cliente 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

Utiliza la biblioteca de cliente 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')

Pruébalo

Utiliza el siguiente explorador de APIs para llamar a este método con datos en tiempo real y ver la respuesta.