Gracias por consultar la versión preliminar de la nueva documentación sobre la plataforma de etiquetas de Google. Este sitio web está en versión beta pública. (Comentarios)

Tags

Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.

Si quieres obtener una lista de métodos para este recurso, consulta el final de esta página.

Representaciones de recursos

Representa una etiqueta de Google Tag Manager.

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    string
  ],
  "liveOnly": boolean,
  "priority": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ]
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      "tagName": string,
      "stopOnSetupFailure": boolean
    }
  ],
  "teardownTag": [
    {
      "tagName": string,
      "stopTeardownOnFailure": boolean
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": string,
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ]
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    "consentStatus": string,
    "consentType": {
      "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.
blockingRuleId[] list ID de las reglas de bloqueo. Si alguna de las reglas enumeradas se evalúa como verdadera, la etiqueta no se activará. admite escritura
blockingTriggerId[] list Bloqueo de los ID de los activadores. Si alguno de los activadores enumerados se evalúa como verdadero, la etiqueta no se activará. admite escritura
consentSettings nested object Configuración de consentimiento de una etiqueta. admite escritura
consentSettings.consentStatus string El estado de consentimiento de la etiqueta Si se establece en NEEDED, el entorno de ejecución verificará que se hayan otorgado los tipos de consentimiento especificados en el campo consent_type.

Los valores aceptables son los siguientes:
  • "needed"
  • "notNeeded"
  • "notSet"
consentSettings.consentType nested object El tipo de consentimiento que se debe comprobar durante la activación de la etiqueta si está en el estado NECESARIO. Este parámetro debe ser del tipo LIST, en el que cada elemento de la lista es del tipo STRING.
consentSettings.consentType.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
consentSettings.consentType.list[] list Los parámetros de este parámetro de lista (las claves se ignorarán). admite escritura
consentSettings.consentType.map[] list Los parámetros de este parámetro de mapa (deben tener claves; las claves deben ser únicas). admite escritura
consentSettings.consentType.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
consentSettings.consentType.value string El valor de un parámetro (puede contener referencias de variables como "") según corresponda para el tipo especificado. admite escritura
containerId string ID del contenedor de GTM.
fingerprint string La huella digital de la etiqueta de GTM, tal como se calcula en el momento del almacenamiento. Este valor se vuelve a calcular cada vez que se modifica la etiqueta.
firingRuleId[] list ID de regla de activación. Se activará una etiqueta cuando alguna de las reglas enumeradas sea verdadera y todos sus blockingRuleIds (si existen) sean falsos. admite escritura
firingTriggerId[] list Activa los ID del activador. Se activará una etiqueta cuando alguno de los activadores enumerados sea verdadero y todos sus blockingTriggerIds (si corresponde) sean falsos. admite escritura
liveOnly boolean Si se establece como verdadera, esta etiqueta solo se activará en el entorno en vivo (p.ej., no está en modo de vista previa ni de depuración). admite escritura
monitoringMetadata nested object Un mapa de los pares clave-valor de los metadatos de etiquetas que se incluirán en los datos de eventos para la supervisión de etiquetas Notas:
  • Este parámetro debe ser del tipo MAP.
  • Cada parámetro del mapa es del tipo TEMPLATE. Sin embargo, no puede contener referencias de variables.
admite escritura
monitoringMetadata.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
monitoringMetadata.list[] list Los parámetros de este parámetro de lista (las claves se ignorarán). admite escritura
monitoringMetadata.map[] list Los parámetros de este parámetro de mapa (deben tener claves; las claves deben ser únicas). admite escritura
monitoringMetadata.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
monitoringMetadata.value string El valor de un parámetro (puede contener referencias de variables como "") según corresponda para el tipo especificado. admite escritura
monitoringMetadataTagNameKey string Si no está vacío, se incluirá el nombre visible de la etiqueta en el mapa de metadatos de supervisión con la clave especificada. admite escritura
name string Nombre visible de la etiqueta. admite escritura
notes string Notas del usuario sobre cómo aplicar esta etiqueta en el contenedor. admite escritura
parameter[] list Los parámetros de la etiqueta. 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 etiqueta de GTM.
paused boolean Indica si la etiqueta está detenida, lo que evita que se active. admite escritura
priority nested object Prioridad numérica definida por el usuario de la etiqueta. Las etiquetas se activan de forma asíncrona en orden de prioridad. Las etiquetas con valores numéricos más altos se activan primero. La prioridad de una etiqueta puede ser un valor positivo o negativo. El valor predeterminado es 0. admite escritura
priority.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
priority.list[] list Los parámetros de este parámetro de lista (las claves se ignorarán). admite escritura
priority.map[] list Los parámetros de este parámetro de mapa (deben tener claves; las claves deben ser únicas). admite escritura
priority.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
priority.value string El valor de un parámetro (puede contener referencias de 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 etiqueta. admite escritura
scheduleStartMs long Es la marca de tiempo de inicio en milisegundos para programar una etiqueta. admite escritura
setupTag[] list La lista de etiquetas de configuración. Actualmente, solo permitimos una.
setupTag[].stopOnSetupFailure boolean Si es verdadero, active la etiqueta principal únicamente si esta se activa correctamente. Si es falso, active la etiqueta principal, independientemente del estado de activación de la etiqueta de configuración.
setupTag[].tagName string El nombre de la etiqueta de configuración.
tagFiringOption string Opción para activar esta etiqueta

Los valores aceptables son los siguientes:
  • "oncePerEvent"
  • "oncePerLoad"
  • "tagFiringOptionUnspecified"
  • "unlimited"
tagId string El ID de etiqueta identifica de forma única la etiqueta de GTM.
tagManagerUrl string Vínculo generado automáticamente a la IU de Tag Manager
teardownTag[] list La lista de etiquetas de desmontaje. Actualmente, solo permitimos una.
teardownTag[].stopTeardownOnFailure boolean Si es verdadero, active la etiqueta de desmontaje solo si la etiqueta principal se activa correctamente. Si es falso, active la etiqueta de desmontaje, independientemente del estado de activación de la etiqueta principal.
teardownTag[].tagName string El nombre de la etiqueta de desmontaje.
type string Tipo de etiqueta de GTM. admite escritura
workspaceId string ID del lugar de trabajo de GTM.

Métodos

crear
Crea una etiqueta de GTM.
borrar
Borra una etiqueta de GTM.
obtener
Obtiene una etiqueta de GTM.
list
Enumera todas las etiquetas de GTM de un contenedor.
revertir
Revierte los cambios en una etiqueta de GTM en un lugar de trabajo de GTM.
actualizar
Actualiza una etiqueta de lanzamiento al mercado.