Variables: update

Requiere autorización

Actualiza una variable de GTM. Pruébalo ahora y ve un ejemplo.

Solicitud

Solicitud HTTP

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

Parámetros

Nombre del parámetro Valor Descripción
Parámetros de ruta de acceso
accountId string El ID de la cuenta de GTM.
containerId string El ID del contenedor de GTM.
variableId string El ID de variable de GTM.
Parámetros de consulta opcionales
fingerprint string Cuando se proporciona, esta huella digital debe coincidir con la de la variable en el almacenamiento.

Autorización

Esta solicitud requiere autorización con el siguiente alcance (obtén más información sobre la autenticación y la autorización).

Permiso
https://www.googleapis.com/auth/tagmanager.edit.containers

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporciona un Recurso de variables con las siguientes propiedades:

Nombre de la propiedad Valor Descripción Notas
Propiedades obligatorias
name string Nombre visible de la variable. admite escritura
parameter[].type string Es el tipo de parámetro. Los valores válidos son los siguientes:
  • boolean: El valor representa un valor booleano, representado como "verdadero" o "falso".
  • integer: El valor representa un número entero de 64 bits con firma, 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 mostrar tipos que no sean de strings).
  • trigger_reference: El valor representa un activador, representado como el ID del activador.


Los valores aceptables son los siguientes:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
admite escritura
type string Tipo de variable de GTM. admite escritura
Propiedades opcionales
disablingTriggerId[] list Solo para contenedores para dispositivos móviles: Es una lista de IDs de activadores para inhabilitar variables condicionales. La variable se habilita si uno de los activadores de habilitación es verdadero, mientras que todos los activadores de inhabilitación son falsos. Se trata como un conjunto sin ordenar. admite escritura
enablingTriggerId[] list Solo para contenedores móviles: Es una lista de IDs de activadores para habilitar variables condicionales. La variable se habilita si uno de los activadores de habilitación es verdadero, mientras que todos los activadores de inhabilitación son falsos. Se trata como un conjunto sin ordenar. admite escritura
notes string Notas del usuario sobre cómo aplicar esta variable en el contenedor. admite escritura
parameter[] list Los parámetros de la variable. admite escritura
parameter[].key string La clave con nombre que identifica un parámetro de forma única. Obligatorio para los parámetros de nivel superior, así como para los valores de mapa. Se ignora para los valores de lista. admite escritura
parameter[].list[] list Los parámetros de este parámetro de lista (se ignorarán las claves). admite escritura
parameter[].map[] list Los parámetros de este parámetro de mapa (deben tener claves; las claves deben ser únicas). admite escritura
parameter[].value string El valor de un parámetro (puede contener referencias variables, como "") según corresponda para el tipo especificado. admite escritura
scheduleEndMs long Es la marca de tiempo de finalización en milisegundos para programar una variable. admite escritura
scheduleStartMs long Es la marca de tiempo de inicio en milisegundos para programar una variable. admite escritura

Respuesta

Si se ejecuta de forma correcta, este método muestra un Recurso de variables 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 cliente para consultar una lista de lenguajes admitidos).

Java

Usa la 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 la 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')

Pruébala

Usa el Explorador de APIs que aparece a continuación para llamar a este método con datos en tiempo real y ver la respuesta.