REST Resource: accounts.containers.workspaces.tags

Recurso: Etiqueta

Representa una etiqueta de Google Tag Manager.

Representación JSON
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    string
  ],
  "liveOnly": boolean,
  "priority": {
    object (Parameter)
  },
  "notes": string,
  "scheduleStartMs": string,
  "scheduleEndMs": string,
  "parameter": [
    {
      object (Parameter)
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      object (SetupTag)
    }
  ],
  "teardownTag": [
    {
      object (TeardownTag)
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": enum (TagFiringOption),
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    object (Parameter)
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    object (ConsentSetting)
  }
}
Campos
path

string

Es la ruta de acceso relativa de la API de la etiqueta de GTM.

accountId

string

ID de la cuenta de GTM.

containerId

string

ID del contenedor de GTM.

workspaceId

string

ID del espacio de trabajo de GTM.

tagId

string

El ID de la etiqueta identifica de forma única la etiqueta de GTM.

name

string

Nombre visible de la etiqueta.

type

string

Tipo de etiqueta de GTM.

firingRuleId[]
(deprecated)

string

IDs de las reglas de activación Se activará una etiqueta cuando alguna de las reglas enumeradas sea verdadera y se cumplan todas sus

blockingRuleIds

(si se especifican) sean falsos.

blockingRuleId[]
(deprecated)

string

IDs de las reglas de bloqueo Si alguna de las reglas enumeradas se evalúa como verdadera, la etiqueta no se activará.

liveOnly

boolean

Si se establece como verdadero, esta etiqueta solo se activará en el entorno en vivo (p.ej., no en la vista previa ni en el modo de depuración).

priority

object (Parameter)

Es la 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 un 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.

notes

string

Notas del usuario sobre cómo aplicar esta etiqueta en el contenedor.

scheduleStartMs

string (int64 format)

La marca de tiempo de inicio en milisegundos para programar una etiqueta.

scheduleEndMs

string (int64 format)

La marca de tiempo de finalización en milisegundos para programar una etiqueta.

parameter[]

object (Parameter)

Los parámetros de la etiqueta

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.

firingTriggerId[]

string

Activación de IDs de activador Una etiqueta se activará cuando cualquiera de los activadores enumerados sea verdadero y se cumplan todas sus

blockingTriggerIds

(si se especifican) sean falsos.

blockingTriggerId[]

string

Bloquea los IDs de activador. Si alguno de los activadores enumerados se evalúa como verdadero, no se activará la etiqueta.

setupTag[]

object (SetupTag)

La lista de etiquetas de configuración. Actualmente, solo permitimos uno.

teardownTag[]

object (TeardownTag)

Es la lista de etiquetas de desmontaje. Actualmente, solo permitimos uno.

parentFolderId

string

Es el ID de la carpeta superior.

tagFiringOption

enum (TagFiringOption)

Es la opción para activar esta etiqueta.

tagManagerUrl

string

Vínculo generado automáticamente a la IU de Tag Manager

paused

boolean

Indica si la etiqueta está pausada, lo que evita que se active.

monitoringMetadata

object (Parameter)

Es 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 de tipo

    MAP

    .

  • Cada parámetro del mapa es de tipo

    TEMPLATE

    Sin embargo, no puede contener referencias de variables.

monitoringMetadataTagNameKey

string

Si no está vacío, el nombre visible de la etiqueta se incluirá en el mapa de metadatos de supervisión con la clave especificada.

consentSettings

object (ConsentSetting)

Configuración de consentimiento de una etiqueta.

SetupTag

Representa una referencia a una etiqueta que se activa antes que otra para configurar dependencias.

Representación JSON
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
Campos
tagName

string

Es el nombre de la etiqueta de configuración.

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.

TeardownTag

Representa una etiqueta que se activa después de otra para quitar las dependencias.

Representación JSON
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
Campos
tagName

string

Es el nombre de la etiqueta de desmontaje.

stopTeardownOnFailure

boolean

Si es verdadero, activa la etiqueta de desinstalación solo si la etiqueta principal se activa correctamente. Si es "false", se activa la etiqueta de desmantelamiento independientemente del estado de activación de la etiqueta principal.

TagFiringOption

Enumeraciones
tagFiringOptionUnspecified
unlimited La etiqueta se puede activar varias veces por evento.
oncePerEvent La etiqueta solo se puede activar por evento, pero se puede activar varias veces por carga (p.ej., carga de la app o carga de la página).
oncePerLoad La etiqueta solo se puede activar por carga (p.ej., carga de la app o carga de la página).

ConsentSetting

Representación JSON
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
Campos
consentStatus

enum (ManualConsentOption)

Es el estado de consentimiento de la etiqueta. Si se establece en NEEDED, el entorno de ejecución verificará que los tipos de consentimiento especificados por el

consentType

campo.

consentType

object (Parameter)

Es el tipo de consentimientos que se deben verificar durante la activación de la etiqueta si se encuentra en el estado NECESITA CONSENTIMIENTO. Este parámetro debe ser del tipo

LIST

donde cada elemento de la lista es de tipo

STRING

.

ManualConsentOption

Enumeraciones
notSet Es el valor predeterminado en el que el usuario no especificó ningún parámetro de configuración.
notNeeded La etiqueta no requiere ninguna configuración de consentimiento adicional.
needed La etiqueta requiere parámetros de configuración de consentimiento adicionales.

Métodos

create

Crea una etiqueta de GTM.

delete

Borra una etiqueta de GTM.

get

Obtiene una etiqueta de GTM.

list

Muestra todas las etiquetas de GTM de un contenedor.

revert

Revierte los cambios en una etiqueta de GTM en un lugar de trabajo de GTM.

update

Actualiza una etiqueta de GTM.