Documentation du protocole de mesure

Présentation

L'envoi de données à Google Analytics à l'aide du protocole de mesure s'effectue en deux étapes:

  1. Transport : où et comment envoyer des données
  2. Charge utile : données envoyées

Ce document décrit le format du transport et de la charge utile.

Transport

Point de terminaison de l'URL

Vous envoyez des données à l'aide du protocole de mesure en envoyant des requêtes HTTP POST au point de terminaison suivant:

https://www.google-analytics.com/mp/collect

Pour envoyer un événement, exécutez la requête POST suivante:

POST /mp/collect HTTP/1.1
HOST: www.google-analytics.com
Content-Type: application/json
<payload_data>

Codes de réponse

Le protocole de mesure renvoie toujours un code d'état 2xx si la requête HTTP a été reçue. Le protocole de mesure ne renvoie pas de code d'erreur si les données de la charge utile sont incorrectes, ou si les données de la charge utile sont incorrectes ou n'ont pas été traitées par Google Analytics.

Charge utile

Les données sont envoyées à Google Analytics à l'aide des données du protocole de mesure, en deux parties:

  1. Paramètres de requête
  2. Un corps JSON POST

paramètres de requête

Nom du paramètre Description

api_secret

Obligatoire. API Secret généré via l'interface utilisateur de Google Analytics.

Pour créer un secret, accédez à l'interface utilisateur de Google Analytics :
Admin > Flux de données > choisir votre flux > Protocole de mesure > Créer

Nous vous recommandons de les garder privées pour votre organisation. Si vous déployez le protocole de mesure côté client, vous devez alterner régulièrement les api_secret pour éviter un spam trop important.

firebase_app_id

 Obligatoire. ID de l'application Firebase. Identifiant d'une application Firebase. Disponible dans la console Firebase sous :
Paramètres du projet > Général > Vos applications > ID de l'application

measurement_id

 ID de mesure. Identifiant d'un flux de données. Pour cela, accédez à l'interface utilisateur de Google Analytics :
Admin > Flux de données > choisir votre flux > ID de mesure

Corps de l'article JSON

Clé Type Description

app_instance_id

 string

Obligatoire. Identifie de manière unique une installation spécifique d'une application Firebase. Cette valeur doit être récupérée via le SDK Firebase.

client_id

 string

Obligatoire. Identifie de manière unique une instance utilisateur d'un client Web. Consultez la section Envoyer un événement au protocole de mesure.

user_id

 string

Facultatif. Identifiant unique d'un utilisateur. Pour en savoir plus sur cet identifiant, consultez User-ID pour l'analyse multiplate-forme.

timestamp_micros

 number

Facultatif. Horodatage Unix (en microsecondes) pour la durée à associer à l'événement. Ce champ ne doit être configuré que pour enregistrer des événements passés. Cette valeur peut être remplacée par user_property ou par des horodatages d'événement. Les événements peuvent dater de trois jours calendaires maximum, selon le fuseau horaire de la propriété.

user_properties

 object Facultatif. Propriétés utilisateur pour la mesure. Pour en savoir plus, consultez Propriétés utilisateur.

non_personalized_ads

 boolean Facultatif. Définissez la valeur sur true pour indiquer que ces événements ne doivent pas être utilisés pour les annonces personnalisées.

events[]

 array Obligatoire. Tableau d'éléments d'événement. Vous pouvez envoyer jusqu'à 25 événements par requête. Consultez la documentation de référence sur events pour tous les événements valides.

events[].name

 string Obligatoire. Nom de l'événement. Consultez la documentation de référence sur les événements pour connaître toutes les options.

events[].params

 object Facultatif. Paramètres de l'événement. Consultez les événements pour obtenir les paramètres suggérés pour chaque événement.

Certains événements comportent des paramètres recommandés. Consultez la section Événements pour connaître les paramètres recommandés pour tous les événements compatibles.

Noms réservés

Noms d'événements réservés

Les noms d'événements suivants sont réservés et ne peuvent pas être utilisés:

  • ad_activeview
  • ad_click
  • ad_exposure
  • ad_impression
  • ad_query
  • ad_reward
  • adunit_exposure
  • app_clear_data
  • app_exception
  • app_install
  • app_remove
  • app_store_refund
  • app_update
  • app_upgrade
  • dynamic_link_app_open
  • dynamic_link_app_update
  • dynamic_link_first_open
  • error
  • firebase_campaign
  • firebase_in_app_message_action
  • firebase_in_app_message_dismiss
  • firebase_in_app_message_impression
  • first_open
  • first_visit
  • in_app_purchase
  • notification_dismiss
  • notification_foreground
  • notification_open
  • notification_receive
  • notification_send
  • os_update
  • screen_view
  • session_start
  • user_engagement

Noms de paramètres réservés

Les noms de paramètres suivants sont réservés et ne peuvent pas être utilisés:

  • firebase_conversion

De plus, les noms des paramètres ne peuvent pas commencer par:

  • _ (underscore)
  • firebase_
  • ga_
  • google_
  • gtag.

Noms de propriétés utilisateur réservés

Les noms de propriété utilisateur suivants sont réservés et ne peuvent pas être utilisés:

  • first_open_time
  • first_visit_time
  • last_deep_link_referrer
  • user_id
  • first_open_after_install

En outre, les noms de propriété utilisateur ne peuvent pas commencer par:

  • _ (underscore)
  • firebase_
  • ga_
  • google_