Documentation de référence du protocole de mesure

Présentation

L'envoi de données à Google Analytics à l'aide du protocole de mesure se compose de deux parties:

  1. Transport : où et comment vous envoyez des données
  2. Charge utile : données que vous envoyez

Ce document décrit la mise en forme du transport et de la charge utile.

Transport

Point de terminaison d'URL

Pour envoyer des données à l'aide du protocole de mesure, envoyez des requêtes HTTP POST au point de terminaison suivant:

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

Pour envoyer un événement, envoyez 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 étaient mal formées, ou si les données de la charge utile étaient 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. Corps POST JSON

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 :
Administration > Flux de données > choisissez votre flux > Protocole de mesure > Créer

Nous vous recommandons de les réserver à votre organisation. Si vous déployez le protocole de mesure côté client, vous devez faire pivoter régulièrement les api_secret pour éviter un spam excessif.

Corps de la publication JSON

Clé Type Description

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. Code temporel Unix (en microsecondes) pour l'heure à associer à l'événement. Cette valeur ne doit être définie que pour enregistrer les événements qui se sont produits dans le passé. Cette valeur peut être remplacée par user_property ou par des horodatages d'événements. Les événements peuvent être rétrodatés jusqu'à trois jours calendaires en fonction du fuseau horaire de l'établissement.

user_properties

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

user_data

 object Facultatif. Données fournies par l'utilisateur. Pour en savoir plus, consultez le guide sur les données fournies par l'utilisateur.
object Facultatif. Définit les paramètres de consentement pour la requête. Pour en savoir plus, consultez la section Consentement.

non_personalized_ads

 boolean Facultatif. Définissez la valeur sur true pour indiquer que les données de l'utilisateur ne doivent pas être utilisées 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 les événements pour connaître 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 Événements pour connaître les paramètres suggérés pour chaque événement.

L'attribut consent configure les types et les états de consentement. Si vous ne spécifiez pas consent, Google Analytics utilisera les paramètres de consentement des interactions en ligne correspondantes pour le client ou l'instance d'application.

Clé Type Description

ad_user_data

 string

Facultatif. Définit le consentement pour l'envoi de données utilisateur provenant des événements et des propriétés utilisateur de la requête à Google à des fins publicitaires.

Doit être défini sur GRANTED ou DENIED.

ad_personalization

 string

Facultatif. Définit le consentement pour la publicité personnalisée pour l'utilisateur.

Doit être défini sur GRANTED ou DENIED.

Paramètres personnalisés

En plus des paramètres prescrits, vous pouvez inclure des paramètres personnalisés de portée utilisateur, de portée événement et de portée article dans une charge utile du protocole de mesure.

  • Les paramètres personnalisés de portée utilisateur peuvent être inclus dans l'objet user_properties de la charge utile.
  • Les paramètres personnalisés de portée événement peuvent être inclus dans l'objet events[].params de la charge utile.
  • Vous pouvez inclure des paramètres personnalisés de portée article dans le tableau items pour chaque événement.

Certains événements comportent des paramètres recommandés. Pour connaître les paramètres recommandés pour tous les événements compatibles, consultez Événements.

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_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
  • 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 de 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és 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

De plus, les noms de propriétés utilisateur ne peuvent pas commencer par :

  • _ (underscore)
  • firebase_
  • ga_
  • google_