Method: events.ingest

Lädt eine Liste von Event-Ressourcen aus der angegebenen 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. Muss für UserData-Uploads angegeben werden. 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 anders codiert sein als der äußere verschlüsselte String. Bei Uploads, die nicht vom Typ UserData sind, wird dieses Feld ignoriert.
encryptionInfo

object (EncryptionInfo)

Optional. Verschlüsselungsinformationen für UserData Uploads. Wenn nichts festgelegt ist, wird davon ausgegangen, dass hochgeladene personenidentifizierbare Informationen gehasht, aber nicht verschlüsselt sind. Bei Uploads, die nicht vom Typ 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,
  "fieldWarnings": [
    {
      object (FieldWarning)
    }
  ]
}
Felder
requestId

string

Die automatisch generierte ID der Anfrage.
fieldWarnings[]

object (FieldWarning)

Detaillierte Warnungen auf Zeilenebene mit Feldpfaden.

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,
  "callInfo": {
    object (CallInfo)
  },
  "conversionValue": number,
  "conversionCount": number
}
Felder
destinationReferences[]

string

Optional. Referenzstring, der zur Bestimmung des Ziels verwendet wird. Wenn dieses Feld leer ist, 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. IDs 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 für den Ort, an dem das Ereignis stattgefunden hat (Web, App, Geschäft usw.).
eventDeviceInfo

object (DeviceInfo)

Optional. Informationen zum Gerät, das zum Zeitpunkt des Ereignisses verwendet wurde (falls vorhanden).
cartData

object (CartData)

Optional. Informationen zur Transaktion und zu den Artikeln, die mit dem Ereignis verknüpft sind.
customVariables[]

object (CustomVariable)

Optional. Zusätzliche Informationen zu Schlüssel/Wert-Paaren, 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 irgendwann in die API aufgenommen werden.
userProperties

object (UserProperties)

Optional. Vom Werbetreibenden ermittelte 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. Eine Gruppe von Ereignisparametern, die im Ereignis enthalten sein sollen und noch nicht über andere strukturierte Felder angegeben wurden.
thirdPartyUserData

object (UserData)

Optional. Dies ist derselbe Datentyp wie in „userData“, wird aber explizit als Daten eines Drittanbieters und nicht als selbst erhobene Daten des Werbetreibenden gekennzeichnet.
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.
callInfo

object (CallInfo)

Optional. Informationen zum Anruf (falls vorhanden), der zu diesem Ereignis geführt hat.
conversionValue

number

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

number

Optional. Die Anzahl der Conversions, die mit dem Ereignis verknüpft sind, für zählungsbasierte Conversions.

AdIdentifiers

IDs 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,
  "dclid": string,
  "impressionId": string,
  "matchId": string,
  "encryptedUserIds": [
    {
      object (EncryptedUserId)
    }
  ],
  "ppid": string,
  "visitorPpid": string,
  "leadId": string
}
Felder
sessionAttributes

string

Optional. Sitzungsattribute für die Ereignisattribution 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-Ereignissen zugeordnet sind und von iOS-Geräten mit mindestens iOS 14 stammen.
landingPageDeviceInfo

object (DeviceInfo)

Optional. Informationen, die über das Gerät erhoben werden, das zum Zeitpunkt der Landung auf der Website des Werbetreibenden nach der Interaktion mit der Anzeige verwendet wird (falls vorhanden).
mobileDeviceId

string

Optional. Die ID für mobile Werbung für Werbetreibende. Das wäre die IDFA unter iOS, die AdID unter Android oder die Kennungen für Werbetreibende auf anderen Plattformen.
dclid

string

Optional. Die mit diesem Ereignis verknüpfte Display-Klick-ID.
impressionId

string

Optional. Die mit diesem Ereignis verknüpfte Impressions-ID.
matchId

string

Optional. Das Feld für die Übereinstimmungs-ID, mit dem dieses Ereignis mit einem vorherigen Ereignis verknüpft wird.
encryptedUserIds[]

object (EncryptedUserId)

Optional. Eine beliebige Anzahl verschlüsselter Nutzer-IDs.
ppid

string

Optional. Eine eindeutige Kennung für einen authentifizierten (angemeldeten) Nutzer, wie vom Publisher definiert.
visitorPpid

string

Optional. Eine eindeutige Kennung für einen nicht authentifizierten Nutzer (Nutzer, der nicht angemeldet ist), wie vom Publisher definiert.
leadId

string

Optional. Von Google generierte ID, die ausgegeben wird, wenn ein Nutzer ein Lead-Formular einreicht.

EncryptedUserId

Eine Nutzer-ID, die für die Attribution verwendet wird. Wenn Sie diese Option verwenden, müssen alle Felder ausgefüllt werden.

JSON-Darstellung 
{
  "encryptedId": string,
  "entityType": enum (EncryptionEntityType),
  "entityId": string,
  "source": enum (EncryptionSource)
}
Felder
encryptedId

string

Erforderlich. Die alphanumerische verschlüsselte ID.
entityType

enum (EncryptionEntityType)

Erforderlich. Der Entitätstyp der Verschlüsselung. Diese sollte mit der Verschlüsselungskonfiguration für die Anzeigenbereitstellung oder die Datenübertragung übereinstimmen.
entityId

string (int64 format)

Erforderlich. Die ID der Verschlüsselungsentität. Diese sollte mit der Verschlüsselungskonfiguration für die Anzeigenbereitstellung oder die Datenübertragung übereinstimmen.
source

enum (EncryptionSource)

Erforderlich. Gibt an, ob das verschlüsselte Cookie über die Anzeigenbereitstellung (Makro „%m“) oder die Datenübertragung empfangen wurde.

EncryptionEntityType

Der Entitätstyp der Verschlüsselung.

Enums
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED Nicht angegebener Verschlüsselungsentitätstyp.
CAMPAIGN_MANAGER_ACCOUNT Campaign Manager 360-Konto
CAMPAIGN_MANAGER_ADVERTISER Campaign Manager 360-Werbetreibenden.
DISPLAY_VIDEO_PARTNER Display & Video 360-Partner
DISPLAY_VIDEO_ADVERTISER Display & Video 360-Werbetreibender
GOOGLE_ADS_CUSTOMER Google Ads-Kunde
GOOGLE_AD_MANAGER_NETWORK_CODE Google Ad Manager-Netzwerkcode.

EncryptionSource

Die Verschlüsselungsquelle.

Enums
ENCRYPTION_SOURCE_UNSPECIFIED Nicht angegebene Verschlüsselungsquelle.
AD_SERVING Verschlüsselungsquelle für die Anzeigenbereitstellung.
DATA_TRANSFER Quelle für die Verschlüsselung der Datenübertragung.

EventSource

Die Quelle des Ereignisses.

Enums
EVENT_SOURCE_UNSPECIFIED Nicht angegebene EventSource. Sollte nicht verwendet werden.
WEB Das Ereignis wurde über einen Webbrowser generiert.
APP Das Ereignis wurde von einer App generiert.
IN_STORE Das Ereignis wurde durch eine Transaktion im Geschäft generiert.
PHONE Das Ereignis wurde aus einem Telefonanruf generiert.
MESSAGE Der Termin wurde anhand einer Nachricht erstellt.
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 mit den Artikeln verknüpfte Merchant Center-ID.
merchantFeedLabel

string

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

string

Optional. Der Sprachcode im ISO 639-1-Format, 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 mit dem Ereignis verknüpften Artikel.
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-Ziel 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, um auf das Element zu verweisen.
additionalItemParameters[]

object (ItemParameter)

Optional. Eine Gruppe von Ereignisparametern, die sich auf einen Artikel beziehen und im Ereignis enthalten sein sollen, aber noch nicht in anderen strukturierten Feldern angegeben wurden.
merchantId

string

Optional. Die mit dem Artikel verknüpfte Merchant Center-ID. Bei Ladenverkäufen wird der auf Warenkorbebene festgelegte Wert überschrieben. Dieses Feld wird für andere Ereignisse 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 Ladenverkäufen wird der auf Warenkorbebene festgelegte Wert überschrieben. Dieses Feld wird für andere Ereignisse ignoriert.
merchantFeedLanguageCode

string

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

object (ItemCustomVariable)

Optional. Zusätzliche Informationen zu Schlüssel/Wert-Paaren, die an die Conversion-Container (Conversion-Aktion oder Floodlight-Aktivität) gesendet werden sollen, wenn Conversions pro Artikel erfasst werden.
conversionValue

number

Optional. Der Conversion-Wert, der diesem Element im Ereignis zugeordnet ist, falls der Conversion-Wert für jedes Element unterschiedlich ist.

ItemParameter

Eine Gruppe von Ereignisparametern, die sich auf einen Artikel beziehen und im Ereignis enthalten sein sollen, aber noch nicht in anderen strukturierten Feldern angegeben wurden.

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

string

Erforderlich. Der Name des zu verwendenden Parameters.
value

string

Erforderlich. Die Stringdarstellung 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 Wert, der für das Feld festgelegt werden soll.

UserProperties

Vom Werbetreibenden ermittelte 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 ermittelte Wert des Kunden.
additionalUserProperties[]

object (UserProperty)

Optional. Ein Bucket mit 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 wieder mit dem Werbetreibenden interagiert.

CustomerValueBucket

Der vom Werbetreibenden ermittelte Wert des Kunden.

Enums
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Nicht angegebener CustomerValueBucket. Sollte nicht verwendet werden.
LOW Der Kunde hat einen niedrigen Wert.
MEDIUM Der Kunde hat einen mittleren Wert.
HIGH Der Kunde hat ein hohes Umsatzpotenzial.

UserProperty

Ein Bucket mit 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 Werts der zu verwendenden 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 Stringdarstellung des Werts des festzulegenden Parameters.

EventLocation

Der Ort, an dem das Ereignis aufgetreten ist.

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

string

Optional. Erforderlich für Ladenverkäufe. Die Kennung für das Geschäft, in dem das Ereignis stattgefunden hat.
city

string

Optional. Der Name der Stadt, in der das Ereignis aufgetreten ist.
subdivisionCode

string

Optional. Der ISO 3166-2-Code für die Verwaltungseinheit, in der das Ereignis aufgetreten ist.
regionCode

string

Optional. Der aus zwei Buchstaben bestehende CLDR-Regionscode der Adresse des Nutzers.
subcontinentCode

string

Optional. Der Subkontinentcode im UN M49-Format, in dem das Ereignis aufgetreten ist.
continentCode

string

Optional. Der Kontinentcode im UN M49-Format, in dem das Ereignis aufgetreten ist.

CallInfo

Informationen zum Anruf (falls vorhanden), der zu diesem Ereignis geführt hat.

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

string (Timestamp format)

Erforderlich. Die Uhrzeit, zu der der Anruf begonnen hat, der zu diesem Ereignis geführt hat.

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".