Variables

Si quieres obtener una lista de métodos para este recurso, consulta el 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)
      ]
    }
  ],
  "enablingTriggerId": [
    string
  ],
  "disablingTriggerId": [
    string
  ],
  "fingerprint": string,
  "parentFolderId": string,
  "tagManagerUrl": string,
  "formatValue": {
    "caseConversionType": string,
    "convertNullToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    },
    "convertUndefinedToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    },
    "convertTrueToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    },
    "convertFalseToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    }
  }
}
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 de dispositivos móviles: Una lista de ID de activadores para inhabilitar variables condicionales. La variable se habilita si uno de los activadores de activación es verdadero, mientras que el activador de inhabilitación es falso. Se trata como un conjunto sin ordenar. admite escritura
enablingTriggerId[] list Solo para contenedores de dispositivos móviles: Una lista de ID 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
fingerprint string La huella digital de la variable de GTM, tal como se calcula 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 un valor de variable en otro valor.
formatValue.caseConversionType string La opción para 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 Valor que se va a convertir si el valor de la variable es falso
formatValue.convertFalseToValue.key string La clave con nombre que identifica de forma exclusiva un parámetro. Obligatorio para los parámetros de nivel superior, así como los valores del mapa. Se ignora para los valores de lista. admite escritura
formatValue.convertFalseToValue.list[] list Los parámetros de este parámetro de lista (las claves se ignorarán). 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 El tipo de parámetro. Los valores válidos son:
  • boolean: El valor representa un valor booleano, que se representa como "true" o "false".
  • integer: El valor representa un valor entero con signo 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; puede incluir referencias variables (incluso referencias variables que podrían mostrar tipos que no son de string).
  • 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 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.key string La clave con nombre que identifica de forma exclusiva un parámetro. Obligatorio para los parámetros de nivel superior, así como los valores del mapa. Se ignora para los valores de lista. admite escritura
formatValue.convertNullToValue.list[] list Los parámetros de este parámetro de lista (las claves se ignorarán). 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 El tipo de parámetro. Los valores válidos son:
  • boolean: El valor representa un valor booleano, que se representa como "true" o "false".
  • integer: El valor representa un valor entero con signo 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; puede incluir referencias variables (incluso referencias variables que podrían mostrar tipos que no son de string).
  • 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 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 la variable es verdadero.
formatValue.convertTrueToValue.key string La clave con nombre que identifica de forma exclusiva un parámetro. Obligatorio para los parámetros de nivel superior, así como los valores del mapa. Se ignora para los valores de lista. admite escritura
formatValue.convertTrueToValue.list[] list Los parámetros de este parámetro de lista (las claves se ignorarán). 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 El tipo de parámetro. Los valores válidos son:
  • boolean: El valor representa un valor booleano, que se representa como "true" o "false".
  • integer: El valor representa un valor entero con signo 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; puede incluir referencias variables (incluso referencias variables que podrían mostrar tipos que no son de string).
  • 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 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.key string La clave con nombre que identifica de forma exclusiva un parámetro. Obligatorio para los parámetros de nivel superior, así como los valores del mapa. Se ignora para los valores de lista. admite escritura
formatValue.convertUndefinedToValue.list[] list Los parámetros de este parámetro de lista (las claves se ignorarán). 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 El tipo de parámetro. Los valores válidos son:
  • boolean: El valor representa un valor booleano, que se representa como "true" o "false".
  • integer: El valor representa un valor entero con signo 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; puede incluir referencias variables (incluso referencias variables que podrían mostrar tipos que no son de string).
  • 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 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 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[].key string La clave con nombre que identifica de forma exclusiva un parámetro. Obligatorio para los parámetros de nivel superior, así como los valores del mapa. Se ignora para los valores de lista. admite escritura
parameter[].list[] list Los parámetros de este parámetro de lista (las claves se ignorarán). 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 El tipo de parámetro. Los valores válidos son:
  • boolean: El valor representa un valor booleano, que se representa como "true" o "false".
  • integer: El valor representa un valor entero con signo 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; puede incluir referencias variables (incluso referencias variables que podrían mostrar tipos que no son de string).
  • 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 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 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 del Administrador de etiquetas de Google. admite escritura
variableId string El ID de la variable identifica de forma única la variable del Administrador de etiquetas de Google.
workspaceId string ID del lugar de trabajo de GTM.

Métodos

crear
Crea una variable de GTM.
borrar
Borra una variable de GTM.
obtener
Obtiene una variable del Administrador de etiquetas de Google.
list
Enumera todas las variables del Administrador de etiquetas de Google de un contenedor.
revertir
Revierte los cambios en una variable de GTM en un lugar de trabajo de GTM.
actualizar
Actualiza una variable de GTM.