REST Resource: accounts.containers.workspaces.tags

Ressource: Tag

Représente une balise Google Tag Manager.

Représentation JSON
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": 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)
  }
}
Champs
path

string

Chemin relatif de l'API de la balise GTM.

accountId

string

ID de compte GTM

containerId

string

ID du conteneur GTM.

workspaceId

string

ID de l'espace de travail GTM.

tagId

string

L'ID de la balise identifie de manière unique la balise GTM.

name

string

Nom à afficher de la balise.

type

string

Type de balise GTM

liveOnly

boolean

Si cette valeur est définie sur "true", cette balise ne se déclenchera que dans l'environnement en ligne (par exemple, pas en mode Aperçu ou Débogage).

priority

object (Parameter)

Priorité numérique définie par l'utilisateur de la balise. Les balises sont déclenchées de manière asynchrone par ordre de priorité. Les balises dont la valeur numérique est 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.

notes

string

Notes de l'utilisateur sur l'application de cette balise dans le conteneur.

scheduleStartMs

string (int64 format)

Code temporel de début en millisecondes pour planifier une balise.

scheduleEndMs

string (int64 format)

Code temporel de fin en millisecondes pour planifier une balise.

parameter[]

object (Parameter)

Paramètres de la balise.

fingerprint

string

Empreinte digitale de la balise GTM calculée au moment du stockage. Cette valeur est recalculée chaque fois que la balise est modifiée.

firingTriggerId[]

string

ID des déclencheurs de déclenchement. Une balise se déclenche lorsque l'un des déclencheurs listés est vrai et que toutes ses

blockingTriggerIds

(le cas échéant) sont faux.

blockingTriggerId[]

string

ID de déclencheur de blocage. Si l'un des déclencheurs listés renvoie la valeur "true", la balise ne se déclenche pas.

setupTag[]

object (SetupTag)

Liste des balises de configuration. Pour le moment, nous n'en acceptons qu'un seul.

teardownTag[]

object (TeardownTag)

Liste des balises de démontage. Pour le moment, nous n'en acceptons qu'un seul.

parentFolderId

string

ID du dossier parent.

tagFiringOption

enum (TagFiringOption)

Option permettant de déclencher cette balise.

tagManagerUrl

string

Lien généré automatiquement vers l'UI de Tag Manager

paused

boolean

Indique si la balise est mise en veille, ce qui l'empêche de se déclencher.

monitoringMetadata

object (Parameter)

Mappage des paires clé-valeur des métadonnées de la balise à 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 de la carte est de type

    TEMPLATE

    ne peuvent toutefois pas contenir de références de variables.

monitoringMetadataTagNameKey

string

Si ce champ n'est pas vide, le nom à afficher de la balise sera inclus dans la carte des métadonnées de surveillance à l'aide de la clé spécifiée.

consentSettings

object (ConsentSetting)

Paramètres de consentement d'une balise.

SetupTag

Représente une référence à une balise qui se déclenche avant une autre balise afin de configurer des dépendances.

Représentation JSON
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
Champs
tagName

string

Nom de la balise de configuration.

stopOnSetupFailure

boolean

Si la valeur est "true", la balise principale se déclenche si et seulement si la balise de configuration se déclenche. Si la valeur est "false", la balise principale se déclenche quel que soit l'état de la balise de configuration.

TeardownTag

Représente une balise qui se déclenche après une autre balise afin de supprimer les dépendances.

Représentation JSON
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
Champs
tagName

string

Nom de la balise de démontage.

stopTeardownOnFailure

boolean

Si la valeur est "true", déclenchez la balise de démontage si et seulement si la balise principale se déclenche correctement. Si la valeur est "false", la balise de démontage se déclenche indépendamment de l'état de déclenchement de la balise principale.

TagFiringOption

Enums
tagFiringOptionUnspecified
unlimited Le tag peut être déclenché plusieurs fois par événement.
oncePerEvent La balise ne peut être déclenchée que par événement, mais elle peut être déclenchée plusieurs fois par chargement (par exemple, chargement de l'application ou de la page).
oncePerLoad La balise ne peut être déclenchée qu'une seule fois par chargement (par exemple, chargement de l'application ou de la page).

ConsentSetting

Représentation JSON
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
Champs
consentStatus

enum (ManualConsentOption)

É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

consentType

champ ont été accordés.

consentType

object (Parameter)

Type de consentements à vérifier lors du déclenchement de la balise si l'état du consentement est "NEEDED" (NÉCESSAIRE). Ce paramètre doit être de type

LIST

où chaque élément de liste est de type

STRING

.

ManualConsentOption

Enums
notSet Valeur par défaut lorsque l'utilisateur n'a pas spécifié de paramètre.
notNeeded La balise ne nécessite aucun paramètre de consentement supplémentaire.
needed La balise nécessite des paramètres de consentement supplémentaires.

Méthodes

create

Crée une balise GTM.

delete

Supprime une balise GTM.

get

Récupère une balise GTM.

list

Répertorie toutes les balises GTM d'un conteneur.

revert

Annule les modifications apportées à une balise GTM dans un espace de travail GTM.

update

Met à jour une balise GTM.