Documentation de référence du protocole de mesure

Présentation

L'envoi de données à Google Analytics à l'aide de l'outil Mesures implique Protocole:

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

Ce document décrit le formatage 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 le 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 HTTP a bien été reçue. Le protocole de mesure ne renvoie pas de code d'erreur si les données de la charge utile étaient incorrectes, ou si les données de la charge utile étaient incorrectes ou n'a pas été traité par Google Analytics.

Charge utile

<ph type="x-smartling-placeholder"></ph>

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

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

paramètres de requête

Nom du paramètre Description

api_secret

Obligatoire. Un API Secret généré via l'UI Google Analytics.

Pour créer un secret, accédez à l'interface utilisateur de Google Analytics et procédez comme suit:
Administration > Flux de données > choisir votre diffusion &gt; Protocole de mesure > Créer

Nous vous recommandons de ne pas les rendre accessibles à votre organisation. Si vous déployez le protocole de mesure côté client, effectuer une rotation régulière des api_secret pour éviter une quantité excessive de spam.

Corps du post JSON

Clé Type Description

user_id

 string

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

<ph type="x-smartling-placeholder">

timestamp_micros

 number

Facultatif. Code temporel Unix (en microsecondes) correspondant à l'heure à associer avec l'événement. Il ne doit être configuré que pour enregistrer les événements qui se sont produits par le passé. Cette valeur peut être remplacée via user_property ou les codes temporels des événements. Les événements peuvent être antidatés jusqu'à trois jours calendaires en fonction du fuseau horaire de la propriété.

<ph type="x-smartling-placeholder">

user_properties

 object Facultatif. Propriétés utilisateur pour la mesure. Voir Utilisateurs propriétés.
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 ce paramètre sur true pour indiquer que les données de l'utilisateur ne doivent pas pour les annonces personnalisées. <ph type="x-smartling-placeholder">

events[]

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

events[].name

 string Obligatoire. Nom de l'événement. Voir les événements référence pour toutes les options.

events[].params

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

L'attribut consent configure les types et les états du consentement. Si vous ne spécifiez pas consent, Google Analytics utilisera le 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 depuis le compte événements et propriétés utilisateur à Google à des fins publicitaires.

Doit être GRANTED ou DENIED.

ad_personalization

 string

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

Doit être GRANTED ou DENIED.

Paramètres personnalisés

En plus des paramètres prescrits, vous pouvez inclure avec une portée utilisateur personnalisée, une portée événement et une portée article paramètres au sein d'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.
  • Vous pouvez inclure des paramètres personnalisés de portée événement dans events[].params de la charge utile.
  • Vous pouvez inclure des paramètres personnalisés de portée article dans la section Tableau items pour chaque événement.

Certains événements comportent des paramètres recommandés. Consultez les événements pour les 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_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_