Method: events.ingest

Lädt eine Liste von Event-Ressourcen aus dem bereitgestellten Destination hoch.

HTTP-Anfrage

POST https://datamanager.googleapis.com/v1/events:ingest

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  }
}
Felder
destinations[]

object (Destination)

Erforderlich. Die Liste der Ziele, an die die Ereignisse gesendet werden sollen.

events[]

object (Event)

Erforderlich. Die Liste der Ereignisse, die an die angegebenen Ziele gesendet werden sollen. In einer einzelnen Anfrage können maximal 2.000 Event-Ressourcen gesendet werden.

consent

object (Consent)

Optional. Einwilligung auf Anfrageebene, die für alle Nutzer in der Anfrage gilt. Die Einwilligung auf Nutzerebene überschreibt die Einwilligung auf Anfrageebene und kann in jedem Event angegeben werden.

validateOnly

boolean

Optional. Zu Testzwecken. Wenn true, wird die Anfrage validiert, aber nicht ausgeführt. Es werden nur Fehler zurückgegeben, keine Ergebnisse.

encoding

enum (Encoding)

Optional. Erforderlich für UserData-Uploads. Der Codierungstyp der Nutzer-IDs. Bei gehashten Nutzer-IDs ist dies der Codierungstyp des gehashten Strings. Bei verschlüsselten gehashten Nutzer-IDs ist dies der Codierungstyp des äußeren verschlüsselten Strings, aber nicht unbedingt des inneren gehashten Strings. Der innere gehashte String kann also auf andere Weise codiert sein als der äußere verschlüsselte String. Bei Uploads, die nicht UserData sind, wird dieses Feld ignoriert.

encryptionInfo

object (EncryptionInfo)

Optional. Informationen zur Verschlüsselung für UserData-Uploads. Wenn nicht festgelegt, wird davon ausgegangen, dass hochgeladene personenidentifizierbare Informationen gehasht, aber nicht verschlüsselt sind. Bei Uploads, die nicht UserData sind, wird dieses Feld ignoriert.

Antworttext

Antwort von IngestEventsRequest.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{
  "requestId": string
}
Felder
requestId

string

Die automatisch generierte ID der Anfrage.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/datamanager

Ereignis

Ein Ereignis, das eine Nutzerinteraktion mit der Website oder App eines Werbetreibenden darstellt.

JSON-Darstellung
{
  "destinationReferences": [
    string
  ],
  "transactionId": string,
  "eventTimestamp": string,
  "lastUpdatedTimestamp": string,
  "userData": {
    object (UserData)
  },
  "consent": {
    object (Consent)
  },
  "adIdentifiers": {
    object (AdIdentifiers)
  },
  "currency": string,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  },
  "eventName": string,
  "clientId": string,
  "userId": string,
  "additionalEventParameters": [
    {
      object (EventParameter)
    }
  ],
  "thirdPartyUserData": {
    object (UserData)
  },
  "eventLocation": {
    object (EventLocation)
  },
  "appInstanceId": string,
  "conversionValue": number
}
Felder
destinationReferences[]

string

Optional. Referenzstring zur Bestimmung des Ziels. Wenn leer, wird das Ereignis an alle destinations in der Anfrage gesendet.

transactionId

string

Optional. Die eindeutige Kennung für dieses Ereignis. Erforderlich für Ereignisse, die als zusätzliche Datenquelle für Tag-Conversions gesendet werden.

eventTimestamp

string (Timestamp format)

Erforderlich. Zeit, zu der das Ereignis aufgetreten ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

lastUpdatedTimestamp

string (Timestamp format)

Optional. Der Zeitpunkt, zu dem das Ereignis zuletzt aktualisiert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

userData

object (UserData)

Optional. Von Nutzern bereitgestellte Daten, die den Nutzer darstellen, mit dem das Ereignis verknüpft ist.

consent

object (Consent)

Optional. Informationen dazu, ob der zugehörige Nutzer verschiedene Arten von Einwilligungen erteilt hat.

adIdentifiers

object (AdIdentifiers)

Optional. Kennungen und andere Informationen, die verwendet werden, um das Conversion-Ereignis mit anderen Onlineaktivitäten (z. B. Anzeigenklicks) abzugleichen.

currency

string

Optional. Der Währungscode, der allen Geldwerten in diesem Ereignis zugeordnet ist.

eventSource

enum (EventSource)

Optional. Signal dafür, wo das Ereignis stattgefunden hat (Web, App, Geschäft usw.).

eventDeviceInfo

object (DeviceInfo)

Optional. Informationen zum verwendeten Gerät (falls vorhanden), als das Ereignis eingetreten ist.

cartData

object (CartData)

Optional. Informationen zur Transaktion und zu den mit dem Ereignis verknüpften Artikeln.

customVariables[]

object (CustomVariable)

Optional. Zusätzliche Schlüssel/Wert-Paar-Informationen, die an die Conversion-Container (Conversion-Aktion oder Floodlight-Aktivität) gesendet werden sollen.

experimentalFields[]

object (ExperimentalField)

Optional. Eine Liste von Schlüssel/Wert-Paaren für experimentelle Felder, die möglicherweise in die API aufgenommen werden.

userProperties

object (UserProperties)

Optional. Vom Werbetreibenden erhobene Informationen zum Nutzer zum Zeitpunkt des Ereignisses.

eventName

string

Optional. Der Name des Ereignisses. Erforderlich für GA4-Ereignisse.

clientId

string

Optional. Eine eindeutige Kennung für die Nutzerinstanz eines Webclients für diesen GA4-Webstream.

userId

string

Optional. Eine eindeutige Kennung für einen Nutzer, die vom Werbetreibenden definiert wird.

additionalEventParameters[]

object (EventParameter)

Optional. Ein Bucket mit Ereignisparametern, die im Ereignis enthalten sein sollen und nicht bereits über andere strukturierte Felder angegeben wurden.

thirdPartyUserData

object (UserData)

Optional. Derselbe Datentyp wie in „userData“, aber explizit als Daten gekennzeichnet, die von einem Drittanbieter bereitgestellt werden und nicht als Daten von Erstanbieter-Werbetreibenden.

eventLocation

object (EventLocation)

Optional. Informationen zum Standort des Nutzers, als dieses Ereignis aufgetreten ist.

appInstanceId

string

Optional. Eine eindeutige Kennung für die Nutzerinstanz eines App-Clients für diesen GA4-App-Stream.

conversionValue

number

Optional. Der mit dem Ereignis verknüpfte Conversion-Wert für wertbezogene Conversions.

AdIdentifiers

Kennungen und andere Informationen, die verwendet werden, um das Conversion-Ereignis mit anderen Onlineaktivitäten (z. B. Anzeigenklicks) abzugleichen.

JSON-Darstellung
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": string
}
Felder
sessionAttributes

string

Optional. Sitzungsattribute für die Ereigniszuordnung und -modellierung.

gclid

string

Optional. Die GCLID (Google Click ID), die diesem Ereignis zugeordnet ist.

gbraid

string

Optional. Die Klick-ID für Klicks, die App-Ereignissen zugeordnet sind und von iOS-Geräten mit mindestens iOS 14 stammen.

wbraid

string

Optional. Die Klick-ID für Klicks, die Web-Events zugeordnet sind und von iOS-Geräten mit mindestens iOS 14 stammen.

landingPageDeviceInfo

object (DeviceInfo)

Optional. Informationen zum verwendeten Gerät (falls vorhanden), die zum Zeitpunkt des Aufrufs der Website des Werbetreibenden nach der Interaktion mit der Anzeige erhoben werden.

mobileDeviceId

string

Optional. Die ID für mobile Werbung für Werbetreibende. Das ist die IDFA unter iOS, die AdID unter Android oder die Kennungen für Werbetreibende anderer Plattformen.

DeviceInfo

Informationen zum Gerät, das bei Eintreten des Ereignisses verwendet wurde (falls zutreffend).

JSON-Darstellung
{
  "userAgent": string,
  "ipAddress": string,
  "category": string,
  "languageCode": string,
  "screenHeight": integer,
  "screenWidth": integer,
  "operatingSystem": string,
  "operatingSystemVersion": string,
  "model": string,
  "brand": string,
  "browser": string,
  "browserVersion": string
}
Felder
userAgent

string

Optional. Der User-Agent-String des Geräts für den angegebenen Kontext.

ipAddress

string

Optional. Die IP-Adresse des Geräts für den angegebenen Kontext.

Hinweis:Google Ads unterstützt keinen IP-Adressen-Abgleich für Endnutzer im Europäischen Wirtschaftsraum (EWR), im Vereinigten Königreich und in der Schweiz. Fügen Sie eine Logik hinzu, um die Weitergabe von IP-Adressen von Nutzern aus diesen Regionen auszuschließen. Informieren Sie die Nutzer außerdem verständlich und umfassend über die Daten, die Sie auf Ihren Websites, in Ihren Apps und in anderen Properties erheben, und holen Sie die Einwilligung der Nutzer ein, sofern dies gesetzlich oder gemäß den anwendbaren Google-Richtlinien erforderlich ist. Weitere Informationen zu Offline-Conversion-Importen

category

string

Optional. Die Kategorie des Geräts. Beispiele: „Computer“, „Tablet“, „Mobilgerät“, „Smart-TV“.

languageCode

string

Optional. Die Sprache, die auf dem Gerät verwendet wird, im ISO 639-1-Format.

screenHeight

integer

Optional. Die Höhe des Bildschirms in Pixeln.

screenWidth

integer

Optional. Die Breite des Bildschirms in Pixeln.

operatingSystem

string

Optional. Das Betriebssystem oder die Plattform des Geräts.

operatingSystemVersion

string

Optional. Die Version des Betriebssystems oder der Plattform.

model

string

Optional. Das Modell des Geräts.

brand

string

Optional. Die Marke des Geräts.

browser

string

Optional. Die Marke oder der Typ des Browsers.

browserVersion

string

Optional. Die Version des Browsers.

EventSource

Die Quelle des Ereignisses.

Enums
EVENT_SOURCE_UNSPECIFIED Nicht angegebene EventSource. Sollte nicht verwendet werden.
WEB Das Ereignis wurde von einem Webbrowser generiert.
APP Der Termin wurde aus einer App generiert.
IN_STORE Der Termin wurde aus einer Transaktion im Geschäft generiert.
PHONE Der Termin wurde aus einem Telefonanruf generiert.
MESSAGE Der Termin wurde aus einer Nachricht generiert.
OTHER Das Ereignis wurde aus anderen Quellen generiert.

CartData

Die mit dem Ereignis verknüpften Warenkorbdaten.

JSON-Darstellung
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ],
  "couponCodes": [
    string
  ]
}
Felder
merchantId

string

Optional. Die Merchant Center-ID, die den Artikeln zugeordnet ist.

merchantFeedLabel

string

Optional. Das Merchant Center-Feedlabel, das mit dem Feed der Artikel verknüpft ist.

merchantFeedLanguageCode

string

Optional. Der Sprachcode in ISO 639-1, der mit dem Merchant Center-Feed der Artikel verknüpft ist, in den Ihre Artikel hochgeladen werden.

transactionDiscount

number

Optional. Die Summe aller Rabatte, die mit der Transaktion verbunden sind.

items[]

object (Item)

Optional. Die Liste der Artikel, die mit dem Ereignis verknüpft sind.

couponCodes[]

string

Optional. Die Liste der Gutscheincodes, die auf den Einkaufswagen angewendet wurden. Gutscheincodes auf Warenkorb- und Artikelebene sind voneinander unabhängig.

Wenn das Ereignis für ein Google Analytics-Zielvorhaben bestimmt ist, geben Sie nur einen Gutscheincode an. Zusätzliche Gutscheincodes werden in Google Analytics ignoriert.

Element

Stellt einen Artikel im Einkaufswagen dar, der mit dem Ereignis verknüpft ist.

JSON-Darstellung
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number,
  "itemId": string,
  "additionalItemParameters": [
    {
      object (ItemParameter)
    }
  ],
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "customVariables": [
    {
      object (ItemCustomVariable)
    }
  ],
  "conversionValue": number
}
Felder
merchantProductId

string

Optional. Die Produkt-ID im Merchant Center-Konto.

quantity

string (int64 format)

Optional. Die Anzahl dieses Artikels, die mit dem Ereignis verknüpft ist.

unitPrice

number

Optional. Der Artikelpreis ohne Steuern, Versand und etwaige Rabatte auf Transaktionsebene.

itemId

string

Optional. Eine eindeutige Kennung, mit der auf das Element verwiesen werden kann.

additionalItemParameters[]

object (ItemParameter)

Optional. Ein Bucket mit allen Ereignisparametern, die sich auf ein Element beziehen, die in das Ereignis aufgenommen werden sollen und noch nicht über andere strukturierte Felder angegeben wurden.

merchantId

string

Optional. Die mit dem Artikel verknüpfte Merchant Center-ID. Bei Store Sales-Ereignissen wird der auf Warenkorbebene festgelegte Wert dadurch überschrieben. Bei anderen Ereignissen wird dieses Feld ignoriert.

merchantFeedLabel

string

Optional. Das Feedlabel des Merchant Center-Feeds. Wenn Länder weiterhin verwendet werden, kann stattdessen der aus zwei Buchstaben bestehende Ländercode nach ISO 3166-1 alpha-2 verwendet werden. Bei Store Sales-Ereignissen wird der auf Warenkorbebene festgelegte Wert dadurch überschrieben. Bei anderen Ereignissen wird dieses Feld ignoriert.

merchantFeedLanguageCode

string

Optional. Der Sprachcode in ISO 639-1, der mit dem Merchant Center-Feed verknüpft ist, in den Ihre Artikel hochgeladen werden.

customVariables[]

object (ItemCustomVariable)

Optional. Zusätzliche Schlüssel/Wert-Paare, die an die Conversion-Container (Conversion-Aktion oder Floodlight-Aktivität) gesendet werden, wenn Conversions auf Artikelebene erfasst werden.

conversionValue

number

Optional. Der Conversion-Wert, der diesem Artikel innerhalb des Ereignisses zugeordnet ist, wenn der Conversion-Wert für die einzelnen Artikel unterschiedlich ist.

ItemParameter

Ein Bucket mit allen Ereignisparametern, die sich auf ein Element beziehen, die in das Ereignis aufgenommen werden sollen und noch nicht über andere strukturierte Felder angegeben wurden.

JSON-Darstellung
{
  "parameterName": string,
  "value": string
}
Felder
parameterName

string

Erforderlich. Der Name des zu verwendenden Parameters.

value

string

Erforderlich. Die String-Darstellung des Werts des festzulegenden Parameters.

ItemCustomVariable

Benutzerdefinierte Variable auf Artikelebene für Anzeigen-Conversions.

JSON-Darstellung
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Felder
variable

string

Optional. Der Name der benutzerdefinierten Variable, die festgelegt werden soll. Wenn die Variable für das angegebene Ziel nicht gefunden wird, wird sie ignoriert.

value

string

Optional. Der Wert, der für die benutzerdefinierte Variable gespeichert werden soll.

destinationReferences[]

string

Optional. Referenzstring, mit dem bestimmt wird, an welche der Event.destination_references die benutzerdefinierte Variable gesendet werden soll. Wenn leer, wird Event.destination_references verwendet.

CustomVariable

Benutzerdefinierte Variable für Anzeigen-Conversions.

JSON-Darstellung
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Felder
variable

string

Optional. Der Name der benutzerdefinierten Variable, die festgelegt werden soll. Wenn die Variable für das angegebene Ziel nicht gefunden wird, wird sie ignoriert.

value

string

Optional. Der Wert, der für die benutzerdefinierte Variable gespeichert werden soll.

destinationReferences[]

string

Optional. Referenzstring, mit dem bestimmt wird, an welche der Event.destination_references die benutzerdefinierte Variable gesendet werden soll. Wenn leer, wird Event.destination_references verwendet.

ExperimentalField

Experimentelles Feld, das inoffizielle Felder darstellt.

JSON-Darstellung
{
  "field": string,
  "value": string
}
Felder
field

string

Optional. Der Name des zu verwendenden Felds.

value

string

Optional. Der festzulegende Wert des Felds.

UserProperties

Vom Werbetreibenden erhobene Informationen zum Nutzer zum Zeitpunkt des Ereignisses. Weitere Informationen finden Sie unter https://support.google.com/google-ads/answer/14007601.

JSON-Darstellung
{
  "customerType": enum (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket),
  "additionalUserProperties": [
    {
      object (UserProperty)
    }
  ]
}
Felder
customerType

enum (CustomerType)

Optional. Typ des Kunden, der mit dem Ereignis verknüpft ist.

customerValueBucket

enum (CustomerValueBucket)

Optional. Der vom Werbetreibenden geschätzte Wert des Kunden.

additionalUserProperties[]

object (UserProperty)

Optional. Ein Bucket mit allen zusätzlichen Nutzereigenschaften für den Nutzer, der mit diesem Ereignis verknüpft ist.

CustomerType

Typ des Kunden, der mit dem Ereignis verknüpft ist.

Enums
CUSTOMER_TYPE_UNSPECIFIED Nicht angegebener CustomerType. Sollte nicht verwendet werden.
NEW Der Kunde ist neu für den Werbetreibenden.
RETURNING Der Kunde kehrt zum Werbetreibenden zurück.
REENGAGED Der Kunde hat sich wieder mit dem Werbetreibenden in Verbindung gesetzt.

CustomerValueBucket

Der vom Werbetreibenden geschätzte Wert des Kunden.

Enums
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Nicht angegebener CustomerValueBucket. Sollte nicht verwendet werden.
LOW Der Kunde hat ein niedriges Umsatzpotenzial.
MEDIUM Der Kunde hat ein mittleres Umsatzpotenzial.
HIGH Der Kunde hat ein hohes Umsatzpotenzial.

UserProperty

Ein Bucket mit allen zusätzlichen Nutzereigenschaften für den Nutzer, der mit diesem Ereignis verknüpft ist.

JSON-Darstellung
{
  "propertyName": string,
  "value": string
}
Felder
propertyName

string

Erforderlich. Der Name der zu verwendenden Nutzereigenschaft.

value

string

Erforderlich. Die Stringdarstellung des zu verwendenden Werts der Nutzereigenschaft.

EventParameter

Ereignisparameter für GA4-Ereignisse.

JSON-Darstellung
{
  "parameterName": string,
  "value": string
}
Felder
parameterName

string

Erforderlich. Der Name des zu verwendenden Parameters.

value

string

Erforderlich. Die String-Darstellung des Werts des festzulegenden Parameters.

EventLocation

Der Ort, an dem das Ereignis stattgefunden hat.

JSON-Darstellung
{
  "storeId": string,
  "city": string,
  "subdivisionCode": string,
  "regionCode": string,
  "subcontinentCode": string,
  "continentCode": string
}
Felder
storeId

string

Optional. Erforderlich für Store Sales. Die Kennung für ein physisches Geschäft, in dem das Ereignis stattgefunden hat.

city

string

Optional. Der Name der Stadt, in der das Ereignis stattgefunden hat.

subdivisionCode

string

Optional. Der ISO 3166-2-Unterteilungscode für den Ort, an dem das Ereignis stattgefunden hat.

regionCode

string

Optional. Der aus zwei Buchstaben bestehende CLDR-Regionscode der Nutzeradresse.

subcontinentCode

string

Optional. Der Subkontinentcode im UN M49-Format, in dem das Ereignis stattgefunden hat.

continentCode

string

Optional. Der Kontinentcode im UN M49-Format, in dem das Ereignis stattgefunden hat.