Validation des appels - Protocole de mesure

Ce document explique comment valider les appels du protocole de mesure Google Analytics.

Présentation

Le protocole de mesure Google Analytics ne renvoie pas de codes d'erreur HTTP, même si un appel du protocole de mesure est incorrect ou n'inclut pas de paramètres obligatoires. Pour vous assurer que vos appels sont correctement formatés et contiennent tous les paramètres requis, vous pouvez les tester sur le serveur de validation avant de les déployer en production.

Ce guide décrit le processus d'envoi des appels au serveur de validation du protocole de mesure et explique comment interpréter la réponse.

Envoyer des appels pour validation

Les appels peuvent être envoyés au serveur de validation du protocole de mesure via n'importe quelle méthode actuellement compatible avec le protocole de mesure. La seule différence réside dans l'URL. Pour envoyer des appels au serveur de validation du protocole de mesure, utilisez le point de terminaison /debug/collect au lieu de /collect. L'exemple suivant montre un appel non valide envoyé au serveur de validation du protocole de mesure:

https://www.google-analytics.com/debug/collect?tid=fake&v=1

Pour en savoir plus sur la création d'un appel du protocole de mesure, consultez la documentation de référence du protocole.

Interpréter la réponse

Les réponses du serveur de validation du protocole de mesure sont au format JSON. L'exemple suivant montre la réponse à l'appel affiché ci-dessus:

{
  "hitParsingResult": [
    {
      "valid": false,
      "hit": "GET /debug/collect?tid=fake\u0026v=1 HTTP/1.1",
      "parserMessage": [
        {
          "messageType": "ERROR",
          "description": "The value provided for parameter 'tid' is invalid. Please see http://goo.gl/a8d4RP#tid for details.",
          "parameter": "tid"
        },
        {
          "messageType": "ERROR",
          "description": "Tracking Id is a required field for this hit. Please see http://goo.gl/a8d4RP#tid for details.",
          "parameter": "tid"
        }
      ]
    }
  ]
}

La racine de la réponse, hitParsingResult, est un tableau dont la longueur correspondra au nombre d'appels envoyés dans la requête d'origine. Chaque objet du tableau contiendra les clés valid, hit et parserMessage. Si un appel n'est pas valide, parserMessage contient un tableau d'objets décrivant les problèmes de validation. Si un appel est valide, parserMessage sera un tableau vide.

Le tableau suivant décrit les propriétés de chaque élément du tableau hitParsingResult:

Clé Type Description
valid Boolean true pour les appels valides, false pour les appels non valides.
hit string Chaîne contenant le chemin d'accès de la requête, ainsi que sa méthode et son protocole.
parserMessage Array Liste des messages de l'analyseur. Si l'appel est valide, ce tableau sera vide.
parserMessage.messageType string Les valeurs possibles sont "INFO", "WARN" et "ERROR".
parserMessage.description string Informations supplémentaires ou étapes supplémentaires pour résoudre le problème de validation.
parserMessage.parameter string|undefined Paramètre (le cas échéant) à l'origine du problème de validation.