Variables: create

Autorisation requise

Crée une variable GTM. Essayez maintenant ou consultez un exemple.

Requête

Requête HTTP

POST https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/variables

Paramètres

Nom du paramètre Valeur Description
Paramètres de chemin d'accès
accountId string ID du compte GTM.
containerId string ID du conteneur GTM.

Autorisation

Une autorisation est requise pour cette requête. Celle-ci doit inclure le champ d'application suivant (en savoir plus sur le processus d'authentification et d'autorisation).

Définition du champ d'application
https://www.googleapis.com/auth/tagmanager.edit.containers

Corps de la requête

Dans le corps de la requête, indiquez une ressource Variables avec les propriétés suivantes:

Nom de propriété Valeur Description Remarques
Propriétés obligatoires
name string Nom à afficher de la variable. 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.


Valeurs acceptées :
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
accessible en écriture
type string Type de variable GTM. accessible en écriture
Propriétés facultatives
disablingTriggerId[] list Pour les conteneurs pour mobile uniquement: liste des ID de déclencheur pour la désactivation des variables conditionnelles. La variable est activée si l'un des déclencheurs d'activation est "true" et tous les déclencheurs de désactivation sont "false". Traitée comme un ensemble non ordonné. accessible en écriture
enablingTriggerId[] list Pour les conteneurs pour mobile uniquement: liste des ID de déclencheur pour l'activation des variables conditionnelles. La variable est activée si l'un des déclencheurs d'activation est défini sur "true", tandis que tous les déclencheurs de désactivation sont faux. Traitée comme un ensemble non ordonné. accessible en écriture
notes string Notes des utilisateurs sur la manière d'appliquer cette variable dans le conteneur accessible en écriture
parameter[] list Paramètres de la variable. 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[].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 pour programmer une variable. accessible en écriture
scheduleStartMs long Code temporel de début, en millisecondes, pour programmer une variable. accessible en écriture

Réponse

Lorsque cette méthode fonctionne, elle renvoie une ressource Variables dans le corps de réponse.

Exemples

Remarque : Les langages de programmation compatibles ne figurent pas tous dans les exemples de code présentés pour cette méthode (consultez la page Bibliothèques clientes pour obtenir la liste des langages compatibles).

Java

Utilise la bibliothèque cliente Java.

/*
 * Note: This code assumes you have an authorized tagmanager service object.
 */

/*
 * This request creates a new variable for the authorized user.
 */

// Create the variable object.
Variable variable = new Variable();
variable.setName("randomNumber");
variable.setType("r"); // The random number type.

try {
  Variable response = tagmanager.accounts().containers().
      variables().create("123456", "54321", variable).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * The results of the create method are stored in the response object.
 * The following code shows how to access the created Id and Fingerprint.
 */
System.out.println("Variable Id = " + response.getVariableId());
System.out.println("Variable Fingerprint = " + response.getFingerprint());

Python

Utilise la bibliothèque cliente Python.

# Note: This code assumes you have an authorized tagmanager service object.

# This request creates a new variable.
try:
  response = tagmanager.accounts().containers().variables().create(
      accountId='23732470',
      containerId='801231',
      body={
          'name': 'random_number',
          'type': 'r'
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

# The results of the create method are stored in response object.
# The following code shows how to access the created id and fingerprint.
print 'Variable Id = %s' % response.get('variableId')
print 'Variable Fingerprint = %s' % response.get('fingerprint')

Essayer

Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.