Zones

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 le contenu d'une zone Google Tag Manager.

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "zoneId": string,
  "name": string,
  "fingerprint": string,
  "tagManagerUrl": string,
  "notes": string,
  "childContainer": [
    {
      "publicId": string,
      "nickname": string
    }
  ],
  "boundary": {
    "condition": [
      {
        "type": string,
        "parameter": [
          {
            "type": string,
            "key": string,
            "value": string,
            "list": [
              (Parameter)
            ],
            "map": [
              (Parameter)
            ],
            "isWeakReference": boolean
          }
        ]
      }
    ],
    "customEvaluationTriggerId": [
      string
    ]
  },
  "typeRestriction": {
    "enable": boolean,
    "whitelistedTypeId": [
      string
    ]
  }
}
Nom de propriété Valeur Description Remarques
accountId string ID de compte GTM.
boundary nested object Limite de cette zone.
boundary.condition[] list Conditions qui, lorsqu'elles sont associées, constituent la limite.
boundary.condition[].parameter[] list Une liste de paramètres nommés (clé/valeur), en fonction du type de la condition. Remarques:
  • Pour les opérateurs binaires, incluez des paramètres nommés arg0 et arg1 afin de spécifier les opérandes de gauche et de droite, respectivement.
  • Pour le moment, l'opérande de gauche (arg0) doit faire référence à une variable.
  • Pour une correspondance avec expression régulière non sensible à la casse, incluez un paramètre booléen nommé ignore_case défini sur true. Si elle n'est pas spécifiée ou définie sur une autre valeur, la correspondance est sensible à la casse.
  • Pour annuler un opérateur, incluez un paramètre booléen nommé negate défini sur true.
accessible en écriture
boundary.condition[].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
boundary.condition[].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
boundary.condition[].parameter[].list[] list Paramètres de ce paramètre de liste (les clés seront ignorées). accessible en écriture
boundary.condition[].parameter[].map[] list Paramètres de ce paramètre de mappage (clés et clés doivent être uniques). accessible en écriture
boundary.condition[].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
boundary.condition[].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
boundary.condition[].type string Type d'opérateur pour cette condition.

Valeurs acceptées :
  • "conditionTypeUnspecified"
  • "contains"
  • "cssSelector"
  • "endsWith"
  • "equals"
  • "greater"
  • "greaterOrEquals"
  • "less"
  • "lessOrEquals"
  • "matchRegex"
  • "startsWith"
  • "urlMatches"
 accessible en écriture
boundary.customEvaluationTriggerId[] list ID des déclencheurs d'évaluation personnalisés Une zone évalue ses conditions limites lorsque l'un des déclencheurs répertoriés est vrai.
childContainer[] list Conteneurs enfants de cette zone
childContainer[].nickname string Pseudo de la zone pour le conteneur enfant.
childContainer[].publicId string ID public du conteneur enfant
containerId string ID de conteneur GTM.
fingerprint string Empreinte numérique de la zone GTM, telle qu'elle est calculée au moment du stockage. Cette valeur est recalculée à chaque modification de la zone.
name string Nom à afficher de la zone.
notes string Notes de l'utilisateur sur la manière d'appliquer cette zone dans le conteneur.
path string Chemin relatif de l'API de la zone GTM.
tagManagerUrl string Lien généré automatiquement vers l'interface utilisateur de Tag Manager
typeRestriction nested object Restrictions de type de cette zone.
typeRestriction.enable boolean "True" si des restrictions de type ont été activées pour cette zone.
typeRestriction.whitelistedTypeId[] list Liste des identifiants publics de type qui ont été ajoutés à la liste blanche pour une utilisation dans cette zone.
workspaceId string ID d'espace de travail GTM.
zoneId string L'ID de zone identifie la zone GTM de manière unique.

Méthodes

créer
Crée une zone GTM.
supprimer
Supprime une zone GTM.
get
Récupère une zone GTM.
liste
Répertorie toutes les zones GTM d'un espace de travail de conteneur GTM.
revert
Annule les modifications apportées à une zone GTM dans un espace de travail GTM.
mise à jour
Met à jour une zone GTM.