Tags

La liste des méthodes associées à cette ressource est présentée au bas de la page.

Représentations de la ressource

Représente une balise 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
    }
  }
}
Nom de propriété Valeur Description Remarques
accountId string ID de compte GTM.
blockingRuleId[] list Blocage d'ID de règles Si l'une des règles listées renvoie la valeur "true", la balise ne se déclenche pas. accessible en écriture
blockingTriggerId[] list Blocage des ID de déclencheurs Si l'un des déclencheurs listés renvoie la valeur "true", la balise ne se déclenchera pas. accessible en écriture
consentSettings nested object Paramètres de consentement d'une balise. accessible en écriture
consentSettings.consentStatus string État du consentement de la balise. Si cette valeur est définie sur NEEDED, l'environnement d'exécution vérifie que les types de consentement spécifiés par le champ consent_type ont été accordés.

Valeurs acceptées :
  • "needed"
  • "notNeeded"
  • "notSet"
consentSettings.consentType nested object Type de consentement à vérifier lors du déclenchement d'une balise si l'état du consentement est REQUIS. Ce paramètre doit être de type LIST, où chaque élément de la liste est de type STRING.
consentSettings.consentType.isWeakReference boolean Indique si un paramètre de type de référence est fortement ou faiblement référencé. Utilisé uniquement par les transformations. accessible en écriture
consentSettings.consentType.key string Clé nommée qui identifie un paramètre de manière unique. Obligatoire pour les paramètres de niveau supérieur ainsi que pour les valeurs de mappage. Ignoré pour les valeurs de liste. accessible en écriture
consentSettings.consentType.list[] list Paramètres de ce paramètre de liste (les clés seront ignorées). accessible en écriture
consentSettings.consentType.map[] list Paramètres de ce paramètre de mappage (clés et clés doivent être uniques). accessible en écriture
consentSettings.consentType.type string Type de paramètre. Voici les valeurs possibles:
  • boolean: la valeur représente une valeur booléenne, représentée par "true" ou "false".
  • integer: la valeur représente un entier signé de 64 bits en base 10
  • list: une liste de paramètres doit être spécifiée.
  • map: un mappage des paramètres doit être spécifié.
  • template: la valeur représente n'importe quel texte. Cela peut inclure des références de variables (même des références de variables pouvant renvoyer des types autres que des chaînes)
  • trigger_reference: la valeur représente un déclencheur, représenté par l'ID du déclencheur.
  • tag_reference: la valeur représente une balise, représentée par le nom de la balise.


Valeurs acceptées :
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
accessible en écriture
consentSettings.consentType.value string Valeur d'un paramètre (peut contenir des références de variables telles que ""), selon le type spécifié. accessible en écriture
containerId string ID de conteneur GTM.
fingerprint string Empreinte numérique de la balise GTM calculée au moment du stockage. Cette valeur est recalculée à chaque modification du tag.
firingRuleId[] list ID des règles de déclenchement Une balise se déclenche lorsque l'une des règles listées est vraie et que tous ses blockingRuleIds (le cas échéant) sont faux. accessible en écriture
firingTriggerId[] list ID des déclencheurs d'activation. Une balise se déclenche lorsque l'un des déclencheurs listés est vrai et que tous ses blockingTriggerIds (le cas échéant) sont définis sur "false". accessible en écriture
liveOnly boolean Si elle est définie sur "True", cette balise ne se déclenchera que dans l'environnement réel (par exemple, pas en mode aperçu ni en mode débogage). accessible en écriture
monitoringMetadata nested object Mappage de paires clé/valeur des métadonnées de balises à inclure dans les données d'événement pour la surveillance des balises. Remarques:
  • Ce paramètre doit être de type MAP.
  • Chaque paramètre du mappage est de type TEMPLATE, mais ne peut pas contenir de références de variables.
accessible en écriture
monitoringMetadata.isWeakReference boolean Indique si un paramètre de type de référence est fortement ou faiblement référencé. Utilisé uniquement par les transformations. accessible en écriture
monitoringMetadata.key string Clé nommée qui identifie un paramètre de manière unique. Obligatoire pour les paramètres de niveau supérieur ainsi que pour les valeurs de mappage. Ignoré pour les valeurs de liste. accessible en écriture
monitoringMetadata.list[] list Paramètres de ce paramètre de liste (les clés seront ignorées). accessible en écriture
monitoringMetadata.map[] list Paramètres de ce paramètre de mappage (clés et clés doivent être uniques). accessible en écriture
monitoringMetadata.type string Type de paramètre. Voici les valeurs possibles:
  • boolean: la valeur représente une valeur booléenne, représentée par "true" ou "false".
  • integer: la valeur représente un entier signé de 64 bits en base 10
  • list: une liste de paramètres doit être spécifiée.
  • map: un mappage des paramètres doit être spécifié.
  • template: la valeur représente n'importe quel texte. Cela peut inclure des références de variables (même des références de variables pouvant renvoyer des types autres que des chaînes)
  • trigger_reference: la valeur représente un déclencheur, représenté par l'ID du déclencheur.
  • tag_reference: la valeur représente une balise, représentée par le nom de la balise.


Valeurs acceptées :
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
accessible en écriture
monitoringMetadata.value string Valeur d'un paramètre (peut contenir des références de variables telles que ""), selon le type spécifié. accessible en écriture
monitoringMetadataTagNameKey string S'il n'est pas vide, le nom à afficher de la balise est inclus dans le mappage des métadonnées de surveillance avec la clé spécifiée. accessible en écriture
name string Nom à afficher du tag. accessible en écriture
notes string Notes de l'utilisateur sur la manière d'appliquer cette balise dans le conteneur accessible en écriture
parameter[] list Paramètres de la balise. accessible en écriture
parameter[].isWeakReference boolean Indique si un paramètre de type de référence est fortement ou faiblement référencé. Utilisé uniquement par les transformations. accessible en écriture
parameter[].key string Clé nommée qui identifie un paramètre de manière unique. Obligatoire pour les paramètres de niveau supérieur ainsi que pour les valeurs de mappage. Ignoré pour les valeurs de liste. accessible en écriture
parameter[].list[] list Paramètres de ce paramètre de liste (les clés seront ignorées). accessible en écriture
parameter[].map[] list Paramètres de ce paramètre de mappage (clés et clés doivent être uniques). accessible en écriture
parameter[].type string Type de paramètre. Voici les valeurs possibles:
  • boolean: la valeur représente une valeur booléenne, représentée par "true" ou "false".
  • integer: la valeur représente un entier signé de 64 bits en base 10
  • list: une liste de paramètres doit être spécifiée.
  • map: un mappage des paramètres doit être spécifié.
  • template: la valeur représente n'importe quel texte. Cela peut inclure des références de variables (même des références de variables pouvant renvoyer des types autres que des chaînes)
  • trigger_reference: la valeur représente un déclencheur, représenté par l'ID du déclencheur.
  • tag_reference: la valeur représente une balise, représentée par le nom de la balise.


Valeurs acceptées :
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
accessible en écriture
parameter[].value string Valeur d'un paramètre (peut contenir des références de variables telles que ""), selon le type spécifié. accessible en écriture
parentFolderId string ID du dossier parent.
path string Chemin relatif de l'API de la balise GTM.
paused boolean Indique si la balise est mise en veille, ce qui empêche son déclenchement. accessible en écriture
priority nested object Priorité numérique du tag définie par l'utilisateur. Les balises sont déclenchées de manière asynchrone, par ordre de priorité. Les balises ayant la valeur numérique la plus élevée sont déclenchées en premier. La priorité d'une balise peut être une valeur positive ou négative. La valeur par défaut est 0. accessible en écriture
priority.isWeakReference boolean Indique si un paramètre de type de référence est fortement ou faiblement référencé. Utilisé uniquement par les transformations. accessible en écriture
priority.key string Clé nommée qui identifie un paramètre de manière unique. Obligatoire pour les paramètres de niveau supérieur ainsi que pour les valeurs de mappage. Ignoré pour les valeurs de liste. accessible en écriture
priority.list[] list Paramètres de ce paramètre de liste (les clés seront ignorées). accessible en écriture
priority.map[] list Paramètres de ce paramètre de mappage (clés et clés doivent être uniques). accessible en écriture
priority.type string Type de paramètre. Voici les valeurs possibles:
  • boolean: la valeur représente une valeur booléenne, représentée par "true" ou "false".
  • integer: la valeur représente un entier signé de 64 bits en base 10
  • list: une liste de paramètres doit être spécifiée.
  • map: un mappage des paramètres doit être spécifié.
  • template: la valeur représente n'importe quel texte. Cela peut inclure des références de variables (même des références de variables pouvant renvoyer des types autres que des chaînes)
  • trigger_reference: la valeur représente un déclencheur, représenté par l'ID du déclencheur.
  • tag_reference: la valeur représente une balise, représentée par le nom de la balise.


Valeurs acceptées :
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
accessible en écriture
priority.value string Valeur d'un paramètre (peut contenir des références de variables telles que ""), selon le type spécifié. accessible en écriture
scheduleEndMs long Code temporel de fin, en millisecondes, de la programmation d'une balise. accessible en écriture
scheduleStartMs long Code temporel de début, en millisecondes, pour programmer une balise. accessible en écriture
setupTag[] list Liste des balises de configuration. Pour le moment, nous n'en autorisons qu'un seul.
setupTag[].stopOnSetupFailure boolean Si la valeur est "true", déclenchez la balise principale si et seulement si la balise de configuration se déclenche correctement. Si la valeur est "false", déclenchez la balise principale, quel que soit l'état de déclenchement de la balise de configuration.
setupTag[].tagName string Nom de la balise de configuration.
tagFiringOption string Option permettant de déclencher cette balise.

Valeurs acceptées :
  • "oncePerEvent"
  • "oncePerLoad"
  • "tagFiringOptionUnspecified"
  • "unlimited"
tagId string L'ID de la balise identifie la balise GTM de manière unique.
tagManagerUrl string Lien généré automatiquement vers l'interface utilisateur de Tag Manager
teardownTag[] list Liste des balises de suppression. Pour le moment, nous n'en autorisons qu'un seul.
teardownTag[].stopTeardownOnFailure boolean Si la valeur est "true", déclenchez la balise teardown si et seulement si la balise principale a bien été déclenchée. Si la valeur est "false", déclenchez la balise de suppression, quel que soit l'état de déclenchement de la balise principale.
teardownTag[].tagName string Nom de la balise teardown.
type string Type de balise GTM. accessible en écriture
workspaceId string ID d'espace de travail GTM.

Méthodes

créer
Crée une balise GTM.
supprimer
Supprime une balise GTM.
get
Reçoit une balise GTM.
liste
Répertorie toutes les balises GTM d'un conteneur.
revert
Reste les modifications apportées à une balise GTM dans un espace de travail GTM.
mise à jour
Met à jour une balise GTM.