Variables

Para obtener una lista de métodos para este recurso, consulta al final de esta página.

Representaciones de recursos

Representa una variable de Google Tag Manager.

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "variableId": string,
  "name": string,
  "type": string,
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "enablingTriggerId": [
    string
  ],
  "disablingTriggerId": [
    string
  ],
  "fingerprint": string,
  "parentFolderId": string,
  "tagManagerUrl": string,
  "formatValue": {
    "caseConversionType": string,
    "convertNullToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertUndefinedToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertTrueToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertFalseToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  }
}
Nombre de la propiedad Valor Descripción Notas
accountId string ID de la cuenta de GTM.
containerId string ID del contenedor de GTM.
disablingTriggerId[] list Solo para contenedores móviles: Una lista de IDs de activadores para inhabilitar variables condicionales la variable está habilitada si uno de los activadores de habilitación es verdadero y todos los activadores de inhabilitación son falsos. Se trata como un conjunto sin ordenar. admite escritura
enablingTriggerId[] list Solo para contenedores móviles: Una lista de IDs de activadores para habilitar variables condicionales la variable estará habilitada 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
fingerprint string La huella digital de la variable GTM calculada en el momento del almacenamiento. Este valor se vuelve a calcular cada vez que se modifica la variable.
formatValue nested object Opción para convertir el valor de una variable en otro valor.
formatValue.caseConversionType string La opción de convertir el valor de una variable de tipo string en minúsculas o mayúsculas.

Los valores aceptables son los siguientes:
  • "lowercase"
  • "none"
  • "uppercase"
formatValue.convertFalseToValue nested object El valor que se debe convertir si el valor de una variable es falso.
formatValue.convertFalseToValue.isWeakReference boolean Indica si se hace referencia fuerte o débil a un parámetro de tipo de referencia. Solo las usan las transformaciones. admite escritura
formatValue.convertFalseToValue.key string La clave con nombre que identifica un parámetro de manera inequívoca. Obligatorio para los parámetros de nivel superior, así como los valores de mapa. Se ignora para los valores de lista. admite escritura
formatValue.convertFalseToValue.list[] list Son los parámetros de este parámetro de lista (se ignorarán las claves). admite escritura
formatValue.convertFalseToValue.map[] list Los parámetros de este parámetro de mapa (deben tener claves; las claves deben ser únicas). admite escritura
formatValue.convertFalseToValue.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 “false”
  • integer: El valor representa un valor entero firmado de 64 bits 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. esto puede incluir referencias variables (incluso referencias variables que pueden mostrar tipos que no son de cadena)
  • trigger_reference: El valor representa un activador, representado como el ID del activador.
  • tag_reference: El valor representa una etiqueta, representada como el nombre de la etiqueta.


Los valores aceptables son los siguientes:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
 admite escritura
formatValue.convertFalseToValue.value string Es el valor de un parámetro (puede contener referencias de variables como "") según corresponda para el tipo especificado. admite escritura
formatValue.convertNullToValue nested object Valor que se va a convertir si el valor de una variable es nulo.
formatValue.convertNullToValue.isWeakReference boolean Indica si se hace referencia fuerte o débil a un parámetro de tipo de referencia. Solo las usan las transformaciones. admite escritura
formatValue.convertNullToValue.key string La clave con nombre que identifica un parámetro de manera inequívoca. Obligatorio para los parámetros de nivel superior, así como los valores de mapa. Se ignora para los valores de lista. admite escritura
formatValue.convertNullToValue.list[] list Son los parámetros de este parámetro de lista (se ignorarán las claves). admite escritura
formatValue.convertNullToValue.map[] list Los parámetros de este parámetro de mapa (deben tener claves; las claves deben ser únicas). admite escritura
formatValue.convertNullToValue.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 “false”
  • integer: El valor representa un valor entero firmado de 64 bits 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. esto puede incluir referencias variables (incluso referencias variables que pueden mostrar tipos que no son de cadena)
  • trigger_reference: El valor representa un activador, representado como el ID del activador.
  • tag_reference: El valor representa una etiqueta, representada como el nombre de la etiqueta.


Los valores aceptables son los siguientes:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
 admite escritura
formatValue.convertNullToValue.value string Es el valor de un parámetro (puede contener referencias de variables como "") según corresponda para el tipo especificado. admite escritura
formatValue.convertTrueToValue nested object Valor que se va a convertir si el valor de una variable es verdadero.
formatValue.convertTrueToValue.isWeakReference boolean Indica si se hace referencia fuerte o débil a un parámetro de tipo de referencia. Solo las usan las transformaciones. admite escritura
formatValue.convertTrueToValue.key string La clave con nombre que identifica un parámetro de manera inequívoca. Obligatorio para los parámetros de nivel superior, así como los valores de mapa. Se ignora para los valores de lista. admite escritura
formatValue.convertTrueToValue.list[] list Son los parámetros de este parámetro de lista (se ignorarán las claves). admite escritura
formatValue.convertTrueToValue.map[] list Los parámetros de este parámetro de mapa (deben tener claves; las claves deben ser únicas). admite escritura
formatValue.convertTrueToValue.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 “false”
  • integer: El valor representa un valor entero firmado de 64 bits 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. esto puede incluir referencias variables (incluso referencias variables que pueden mostrar tipos que no son de cadena)
  • trigger_reference: El valor representa un activador, representado como el ID del activador.
  • tag_reference: El valor representa una etiqueta, representada como el nombre de la etiqueta.


Los valores aceptables son los siguientes:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
 admite escritura
formatValue.convertTrueToValue.value string Es el valor de un parámetro (puede contener referencias de variables como "") según corresponda para el tipo especificado. admite escritura
formatValue.convertUndefinedToValue nested object Valor que se va a convertir si el valor de una variable no está definido.
formatValue.convertUndefinedToValue.isWeakReference boolean Indica si se hace referencia fuerte o débil a un parámetro de tipo de referencia. Solo las usan las transformaciones. admite escritura
formatValue.convertUndefinedToValue.key string La clave con nombre que identifica un parámetro de manera inequívoca. Obligatorio para los parámetros de nivel superior, así como los valores de mapa. Se ignora para los valores de lista. admite escritura
formatValue.convertUndefinedToValue.list[] list Son los parámetros de este parámetro de lista (se ignorarán las claves). admite escritura
formatValue.convertUndefinedToValue.map[] list Los parámetros de este parámetro de mapa (deben tener claves; las claves deben ser únicas). admite escritura
formatValue.convertUndefinedToValue.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 “false”
  • integer: El valor representa un valor entero firmado de 64 bits 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. esto puede incluir referencias variables (incluso referencias variables que pueden mostrar tipos que no son de cadena)
  • trigger_reference: El valor representa un activador, representado como el ID del activador.
  • tag_reference: El valor representa una etiqueta, representada como el nombre de la etiqueta.


Los valores aceptables son los siguientes:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
 admite escritura
formatValue.convertUndefinedToValue.value string Es el valor de un parámetro (puede contener referencias de variables como "") según corresponda para el tipo especificado. admite escritura
name string Nombre visible de la variable. 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[].isWeakReference boolean Indica si se hace referencia fuerte o débil a un parámetro de tipo de referencia. Solo las usan las transformaciones. admite escritura
parameter[].key string La clave con nombre que identifica un parámetro de manera inequívoca. Obligatorio para los parámetros de nivel superior, así como los valores de mapa. Se ignora para los valores de lista. admite escritura
parameter[].list[] list Son 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[].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 “false”
  • integer: El valor representa un valor entero firmado de 64 bits 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. esto puede incluir referencias variables (incluso referencias variables que pueden mostrar tipos que no son de cadena)
  • trigger_reference: El valor representa un activador, representado como el ID del activador.
  • tag_reference: El valor representa una etiqueta, representada como el nombre de la etiqueta.


Los valores aceptables son los siguientes:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
 admite escritura
parameter[].value string Es el valor de un parámetro (puede contener referencias de variables como "") según corresponda para el tipo especificado. admite escritura
parentFolderId string ID de la carpeta superior.
path string Ruta de acceso relativa de la API de la variable GTM.
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
tagManagerUrl string Vínculo generado automáticamente a la IU de Tag Manager
type string Tipo de variable de GTM. admite escritura
variableId string El ID de variable identifica de forma inequívoca la variable GTM.
workspaceId string ID del lugar de trabajo de GTM.

Métodos

crear
Crea una variable de GTM.
borrar
Borra una variable de GTM.
get
Obtiene una variable de GTM.
list
Enumera todas las variables de GTM de un contenedor.
revertir
Revierte los cambios en una variable de GTM en un lugar de trabajo de GTM.
actualización
Actualiza una variable de GTM.