Tags

Para obtener una lista de métodos para este recurso, consulta al 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)
    ],
    "isWeakReference": boolean
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "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)
    ],
    "isWeakReference": boolean
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    "consentStatus": string,
    "consentType": {
      "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.
blockingRuleId[] list ID de las reglas de bloqueo. Si alguna de las reglas mencionadas se evalúa como verdadera, la etiqueta no se activará. admite escritura
blockingTriggerId[] list ID de activador de bloqueo. 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 como 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 Es el tipo de consentimientos que se deben verificar durante la activación de la etiqueta si tienen el estado de consentimiento NEEDED. Este parámetro debe ser del tipo LIST, donde cada elemento de la lista es del tipo STRING.
consentSettings.consentType.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
consentSettings.consentType.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
consentSettings.consentType.list[] list Son los parámetros de este parámetro de lista (se ignorarán las claves). 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 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
consentSettings.consentType.value string Es 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 reglas de activación Se activará una etiqueta cuando alguna de las reglas de la lista sea verdadera y todos sus blockingRuleIds (si los hay) son falsos. admite escritura
firingTriggerId[] list IDs de activadores Se activará una etiqueta cuando alguno de los activadores de la lista sea verdadero y todos sus blockingTriggerIds (si se especifica alguno) son falsos. admite escritura
liveOnly boolean Si la estableces como verdadera, esta etiqueta solo se activará en el entorno publicado (p.ej., no en el modo de vista previa ni de depuración). admite escritura
monitoringMetadata nested object Un mapa de pares clave-valor de 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 de tipo TEMPLATE. Sin embargo, no puede contener referencias de variables.
 admite escritura
monitoringMetadata.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
monitoringMetadata.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
monitoringMetadata.list[] list Son los parámetros de este parámetro de lista (se ignorarán las claves). 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 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
monitoringMetadata.value string Es 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, el nombre visible de la etiqueta se incluirá en el mapa de metadatos de supervisión usando 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[].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 etiqueta de GTM.
paused boolean Indica si la etiqueta está detenida, lo que impide que se active. admite escritura
priority nested object Prioridad numérica de la etiqueta definida por el usuario Las etiquetas se activan de forma asíncrona en orden de prioridad. Las etiquetas con valor numérico más alto se activan primero. La prioridad de una etiqueta puede ser un valor positivo o negativo. El valor predeterminado es 0. admite escritura
priority.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
priority.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
priority.list[] list Son los parámetros de este parámetro de lista (se ignorarán las claves). 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 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
priority.value string Es 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. Por el momento, solo permitimos una.
setupTag[].stopOnSetupFailure boolean Si es verdadero, activa la etiqueta principal solo si la etiqueta de configuración se activa correctamente. Si es falso, activa 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 exclusiva la etiqueta de GTM.
tagManagerUrl string Vínculo generado automáticamente a la IU de Tag Manager
teardownTag[] list La lista de etiquetas de eliminación. Por el momento, solo permitimos una.
teardownTag[].stopTeardownOnFailure boolean Si es verdadero, activa la etiqueta de desmontaje solo si la etiqueta principal se activa correctamente. Si es falso, activa la etiqueta de eliminación 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.
get
Obtiene una etiqueta de GTM.
list
Enumera todas las etiquetas de GTM de un contenedor.
revertir
Revierte los cambios realizados en una etiqueta de GTM en un lugar de trabajo de GTM.
actualización
Actualiza una etiqueta de GTM.