Measurement Protocol-Referenz

Überblick

Das Senden von Daten an Google Analytics mithilfe des Measurement Protocol besteht aus zwei Teilen:

  1. Transport – wo und wie Sie Daten senden
  2. Nutzlast – die von Ihnen gesendeten Daten

In diesem Dokument wird beschrieben, wie Transport und Nutzlast formatiert sind.

Transport

URL-Endpunkt

Zum Senden von Daten mithilfe des Measurement Protocol stellen Sie HTTP-POST-Anfragen an den folgenden Endpunkt:

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

Um ein Ereignis zu senden, senden Sie die folgende POST-Anfrage:

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

Antwortcodes

Das Measurement Protocol gibt immer den Statuscode 2xx zurück, wenn die HTTP-Anfrage empfangen wurde. Das Measurement Protocol gibt keinen Fehlercode zurück, wenn die Nutzlastdaten fehlerhaft waren oder wenn die Daten in der Nutzlast falsch waren oder nicht von Google Analytics verarbeitet wurden.

Nutzlast

Daten werden mithilfe der Measurement Protocol-Daten an Google Analytics gesendet, die aus zwei Teilen bestehen:

  1. Abfrageparameter
  2. Ein JSON-POST-Text

Suchparameter

Parametername Beschreibung

api_secret

Erforderlich. Ein API Secret, das über die Google Analytics-Benutzeroberfläche generiert wird.

Zum Erstellen eines neuen Secrets rufen Sie die Google Analytics-Benutzeroberfläche auf:
Verwaltung > Datenstreams > Stream auswählen > Measurement Protocol > Erstellen

Wir empfehlen Ihnen, diese auf Ihre Organisation zu beschränken. Wenn Sie das Measurement Protocol clientseitig bereitstellen, sollten Sie api_secrets regelmäßig rotieren, um übermäßigen SPAM zu vermeiden.

firebase_app_id

Erforderlich. Firebase-App-ID Die Kennung für eine Firebase-App. Sie finden sie in der Firebase Console unter:
Projekteinstellungen > Allgemein > Meine Apps > App-ID

measurement_id

Mess-ID: Die ID für einen Datenstream. Sie finden die Google Analytics-Benutzeroberfläche unter:
Verwaltung > Datenstreams > Stream auswählen > Mess-ID

JSON-Beitragstext

Schlüssel Typ Beschreibung

app_instance_id

string

Erforderlich. Hiermit wird eine bestimmte Installation einer Firebase-App eindeutig identifiziert. Dieser Wert muss über das Firebase SDK abgerufen werden.

client_id

string

Erforderlich. Kennzeichnet eine Nutzerinstanz eines Webclients eindeutig. Weitere Informationen finden Sie unter Ereignis an das Measurement Protocol senden.

user_id

string

Optional. Eine eindeutige Kennung für einen Nutzer. Weitere Informationen zu dieser ID finden Sie unter User-ID für plattformübergreifende Analysen.

timestamp_micros

number

Optional. Ein Unix-Zeitstempel (in Mikrosekunden) für die Zeit, die dem Ereignis zugeordnet werden soll. Diese sollte nur so eingestellt werden, dass Ereignisse aufgezeichnet werden, die in der Vergangenheit stattgefunden haben. Dieser Wert kann über user_property oder Ereigniszeitstempel überschrieben werden. Termine können je nach Zeitzone der Property bis zu 3 Kalendertage rückdatiert werden.

user_properties

object Optional. Die Nutzereigenschaften für die Messung. Weitere Informationen finden Sie unter Nutzereigenschaften.
object Optional. Legt die Einwilligungseinstellungen für die Anfrage fest. Weitere Informationen finden Sie im Abschnitt „Einwilligung“.

non_personalized_ads

boolean Optional. Legen Sie true fest, um anzugeben, dass die Daten des Nutzers nicht für personalisierte Werbung verwendet werden sollen.

events[]

array Erforderlich. Array mit Ereigniselementen Pro Anfrage können bis zu 25 Ereignisse gesendet werden. Alle gültigen Ereignisse finden Sie in der Ereignisreferenz.

events[].name

string Erforderlich. Der Name des Ereignisses. In der Ereignisreferenz finden Sie alle Optionen.

events[].params

object Optional. Die Parameter für das Ereignis. Unter Ereignisse finden Sie die empfohlenen Parameter für jedes Ereignis.

Mit dem Attribut consent werden die Arten und Status von Einwilligungen konfiguriert. Wenn Sie consent nicht angeben, verwendet Google Analytics die Einwilligungseinstellungen der entsprechenden Onlineinteraktionen für den Client oder die App-Instanz.

Schlüssel Typ Beschreibung

ad_user_data

string

Optional. Legt die Einwilligung für das Senden von Nutzerdaten aus den Ereignissen und Nutzereigenschaften der Anfrage zu Werbezwecken an Google fest.

Muss entweder GRANTED oder DENIED sein.

ad_personalization

string

Optional. Legt die Einwilligung für personalisierte Anzeigen für den Nutzer fest.

Muss entweder GRANTED oder DENIED sein.

Benutzerdefinierte Parameter

Zusätzlich zu den vorgeschriebenen Parametern können Sie in eine Measurement Protocol-Nutzlast benutzerdefinierte Parameter auf Nutzer-, Ereignis- und Artikelebene aufnehmen.

  • Benutzerdefinierte Parameter auf Nutzerebene können in das user_properties-Objekt der Nutzlast aufgenommen werden.
  • Benutzerdefinierte Parameter auf Ereignisebene können in das events[].params-Objekt der Nutzlast aufgenommen werden.
  • Benutzerdefinierte Parameter auf Artikelebene können für jedes Ereignis in das items-Array aufgenommen werden.

Für einige Ereignisse gibt es empfohlene Parameter. Die empfohlenen Parameter für alle unterstützten Ereignisse finden Sie unter Ereignisse.

Reservierte Namen

Reservierte Ereignisnamen

Die folgenden Ereignisnamen sind reserviert und können nicht verwendet werden:

  • 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

Reservierte Parameternamen

Die folgenden Parameternamen sind reserviert und können nicht verwendet werden:

  • firebase_conversion

Außerdem dürfen Parameternamen nicht mit folgenden Zeichen oder Präfixen beginnen:

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

Reservierte Namen von Nutzereigenschaften

Die folgenden Namen von Nutzereigenschaften sind reserviert und können nicht verwendet werden:

  • first_open_time
  • first_visit_time
  • last_deep_link_referrer
  • user_id
  • first_open_after_install

Außerdem dürfen Namen von Nutzereigenschaften nicht mit folgenden Zeichen oder Präfixen beginnen:

  • _ (underscore)
  • firebase_
  • ga_
  • google_