Variables

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 variable Google Tag Manager.

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "variableId": string,
  "name": string,
  "type": string,
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "enablingTriggerId": [
    string
  ],
  "disablingTriggerId": [
    string
  ],
  "fingerprint": string,
  "parentFolderId": string,
  "tagManagerUrl": string,
  "formatValue": {
    "caseConversionType": string,
    "convertNullToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertUndefinedToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertTrueToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    },
    "convertFalseToValue": {
      "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.
containerId string ID du conteneur GTM.
disablingTriggerId[] list Pour les conteneurs pour mobile uniquement: une liste d'ID de déclencheurs pour la désactivation des variables conditionnelles la variable est activée si l'un des déclencheurs d'activation est défini sur "true" alors que tous les déclencheurs de désactivation sont "false". Traité comme un ensemble non ordonné. accessible en écriture
enablingTriggerId[] list Pour les conteneurs pour mobile uniquement: une liste d'ID de déclencheurs pour activer les variables conditionnelles La variable est activée si l'un des déclencheurs d'activation est défini sur "true" alors que tous les déclencheurs de désactivation sont "false". Traité comme un ensemble non ordonné. accessible en écriture
fingerprint string Empreinte numérique de la variable GTM calculée au moment du stockage. Cette valeur est recalculée chaque fois que la variable est modifiée.
formatValue nested object Option permettant de convertir une valeur de variable en une autre valeur.
formatValue.caseConversionType string L'option permettant de convertir une valeur de variable de type chaîne en minuscules ou en majuscules.

Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
    </ph>
  • "lowercase"
  • "none"
  • "uppercase"
formatValue.convertFalseToValue nested object Valeur à convertir si une valeur de variable est fausse.
formatValue.convertFalseToValue.isWeakReference boolean Indique si un paramètre de type de référence est référencé fortement ou faiblement. Utilisé uniquement par les transformations. accessible en écriture
formatValue.convertFalseToValue.key string Clé nommée qui identifie un paramètre de manière unique. Obligatoire pour les paramètres de niveau supérieur et les valeurs de carte. Ignoré pour les valeurs de liste. accessible en écriture
formatValue.convertFalseToValue.list[] list Paramètres de ce paramètre de liste (les clés seront ignorées). accessible en écriture
formatValue.convertFalseToValue.map[] list Paramètres de ce paramètre de mappage (ils doivent comporter des clés, les clés doivent être uniques). accessible en écriture
formatValue.convertFalseToValue.type string Type de paramètre. Les valeurs possibles sont les suivantes:
  • boolean: la valeur représente une valeur booléenne, représentée par "true" (vrai). ou "false"
  • integer: la valeur représente un nombre entier signé de 64 bits, en base 10.
  • list: une liste de paramètres doit être spécifiée
  • map: un mappage de paramètres doit être spécifié.
  • template: la valeur représente n'importe quel texte. cela peut inclure des références à des variables (même des références à des variables qui pourraient 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.


Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
    </ph>
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
 accessible en écriture
formatValue.convertFalseToValue.value string Valeur d'un paramètre (peut contenir des références de variable telles que "") selon le type spécifié. accessible en écriture
formatValue.convertNullToValue nested object Valeur à convertir si une valeur de variable est nulle.
formatValue.convertNullToValue.isWeakReference boolean Indique si un paramètre de type de référence est référencé fortement ou faiblement. Utilisé uniquement par les transformations. accessible en écriture
formatValue.convertNullToValue.key string Clé nommée qui identifie un paramètre de manière unique. Obligatoire pour les paramètres de niveau supérieur et les valeurs de carte. Ignoré pour les valeurs de liste. accessible en écriture
formatValue.convertNullToValue.list[] list Paramètres de ce paramètre de liste (les clés seront ignorées). accessible en écriture
formatValue.convertNullToValue.map[] list Paramètres de ce paramètre de mappage (ils doivent comporter des clés, les clés doivent être uniques). accessible en écriture
formatValue.convertNullToValue.type string Type de paramètre. Les valeurs possibles sont les suivantes:
  • boolean: la valeur représente une valeur booléenne, représentée par "true" (vrai). ou "false"
  • integer: la valeur représente un nombre entier signé de 64 bits, en base 10.
  • list: une liste de paramètres doit être spécifiée
  • map: un mappage de paramètres doit être spécifié.
  • template: la valeur représente n'importe quel texte. cela peut inclure des références à des variables (même des références à des variables qui pourraient 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.


Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
    </ph>
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
 accessible en écriture
formatValue.convertNullToValue.value string Valeur d'un paramètre (peut contenir des références de variable telles que "") selon le type spécifié. accessible en écriture
formatValue.convertTrueToValue nested object Valeur à convertir si une valeur de variable est "true".
formatValue.convertTrueToValue.isWeakReference boolean Indique si un paramètre de type de référence est référencé fortement ou faiblement. Utilisé uniquement par les transformations. accessible en écriture
formatValue.convertTrueToValue.key string Clé nommée qui identifie un paramètre de manière unique. Obligatoire pour les paramètres de niveau supérieur et les valeurs de carte. Ignoré pour les valeurs de liste. accessible en écriture
formatValue.convertTrueToValue.list[] list Paramètres de ce paramètre de liste (les clés seront ignorées). accessible en écriture
formatValue.convertTrueToValue.map[] list Paramètres de ce paramètre de mappage (ils doivent comporter des clés, les clés doivent être uniques). accessible en écriture
formatValue.convertTrueToValue.type string Type de paramètre. Les valeurs possibles sont les suivantes:
  • boolean: la valeur représente une valeur booléenne, représentée par "true" (vrai). ou "false"
  • integer: la valeur représente un nombre entier signé de 64 bits, en base 10.
  • list: une liste de paramètres doit être spécifiée
  • map: un mappage de paramètres doit être spécifié.
  • template: la valeur représente n'importe quel texte. cela peut inclure des références à des variables (même des références à des variables qui pourraient 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.


Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
    </ph>
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
 accessible en écriture
formatValue.convertTrueToValue.value string Valeur d'un paramètre (peut contenir des références de variable telles que "") selon le type spécifié. accessible en écriture
formatValue.convertUndefinedToValue nested object Valeur à convertir si une valeur de variable n'est pas définie.
formatValue.convertUndefinedToValue.isWeakReference boolean Indique si un paramètre de type de référence est référencé fortement ou faiblement. Utilisé uniquement par les transformations. accessible en écriture
formatValue.convertUndefinedToValue.key string Clé nommée qui identifie un paramètre de manière unique. Obligatoire pour les paramètres de niveau supérieur et les valeurs de carte. Ignoré pour les valeurs de liste. accessible en écriture
formatValue.convertUndefinedToValue.list[] list Paramètres de ce paramètre de liste (les clés seront ignorées). accessible en écriture
formatValue.convertUndefinedToValue.map[] list Paramètres de ce paramètre de mappage (ils doivent comporter des clés, les clés doivent être uniques). accessible en écriture
formatValue.convertUndefinedToValue.type string Type de paramètre. Les valeurs possibles sont les suivantes:
  • boolean: la valeur représente une valeur booléenne, représentée par "true" (vrai). ou "false"
  • integer: la valeur représente un nombre entier signé de 64 bits, en base 10.
  • list: une liste de paramètres doit être spécifiée
  • map: un mappage de paramètres doit être spécifié.
  • template: la valeur représente n'importe quel texte. cela peut inclure des références à des variables (même des références à des variables qui pourraient 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.


Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
    </ph>
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
 accessible en écriture
formatValue.convertUndefinedToValue.value string Valeur d'un paramètre (peut contenir des références de variable telles que "") selon le type spécifié. accessible en écriture
name string Nom à afficher de la variable accessible en écriture
notes string Remarques de l'utilisateur expliquant comment appliquer cette variable dans le conteneur. accessible en écriture
parameter[] list Paramètres de la variable. accessible en écriture
parameter[].isWeakReference boolean Indique si un paramètre de type de référence est référencé fortement ou faiblement. 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 et les valeurs de carte. 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 (ils doivent comporter des clés, les clés doivent être uniques). accessible en écriture
parameter[].type string Type de paramètre. Les valeurs possibles sont les suivantes:
  • boolean: la valeur représente une valeur booléenne, représentée par "true" (vrai). ou "false"
  • integer: la valeur représente un nombre entier signé de 64 bits, en base 10.
  • list: une liste de paramètres doit être spécifiée
  • map: un mappage de paramètres doit être spécifié.
  • template: la valeur représente n'importe quel texte. cela peut inclure des références à des variables (même des références à des variables qui pourraient 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.


Les valeurs possibles sont les suivantes: <ph type="x-smartling-placeholder">
    </ph>
  • "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 variable 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 variable GTM.
scheduleEndMs long Code temporel de fin, en millisecondes, de planification d'une variable. accessible en écriture
scheduleStartMs long Code temporel de début, en millisecondes, de programmation d'une variable. accessible en écriture
tagManagerUrl string Lien généré automatiquement vers l'interface utilisateur de Tag Manager
type string Type de variable GTM. accessible en écriture
variableId string L'ID de variable identifie la variable GTM de manière unique.
workspaceId string ID d'espace de travail GTM.

Méthodes

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