Method: events.ingest

Lädt eine Liste mit 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 Nutzerkennungen. 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 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 personenbezogene Daten 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,
  "conversionValue": number,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  }
}
Felder
destinationReferences[]

string

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

transactionId

string

Erforderlich. Die eindeutige Kennung für dieses Ereignis.

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.

conversionValue

number

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

eventSource

enum (EventSource)

Optional. Signal dafür, wo 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 zutreffend).

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-Paare, 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.

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)
  }
}
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-Events zugeordnet sind und von iOS-Geräten mit mindestens iOS 14 stammen.

landingPageDeviceInfo

object (DeviceInfo)

Optional. Informationen zum verwendeten Gerät (falls vorhanden), wenn der Nutzer nach der Interaktion mit der Anzeige auf der Website des Werbetreibenden landet.

DeviceInfo

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

JSON-Darstellung
{
  "userAgent": string,
  "ipAddress": 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-Adressenabgleich für Endnutzer im Europäischen Wirtschaftsraum (EWR), im Vereinigten Königreich (VK) oder in der Schweiz (CH). Fügen Sie Logik hinzu, um die Weitergabe von IP-Adressen von Nutzern aus diesen Regionen bedingt auszuschließen. Stellen Sie außerdem sicher, dass Sie Nutzer verständlich und umfassend über die Daten informieren, die Sie auf Ihren Websites, in Ihren Apps und in anderen Properties erheben, und holen Sie die Einwilligung ein, sofern dies gesetzlich oder gemäß den anwendbaren Google-Richtlinien erforderlich ist. Weitere Informationen zu Offline-Conversion-Importen

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 Das Ereignis wurde aus einer Transaktion im Geschäft generiert.
PHONE Das Ereignis wurde aus einem Telefonanruf 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)
    }
  ]
}
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 der Transaktion zugeordnet sind.

items[]

object (Item)

Optional. Die Liste der mit dem Ereignis verknüpften Elemente.

Element

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

JSON-Darstellung
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": 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.

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 für inoffizielle Felder.

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

string

Optional. Der Name des zu verwendenden Felds.

value

string

Optional. Der Wert, auf den das Feld festgelegt werden soll.

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)
}
Felder
customerType

enum (CustomerType)

Optional. Typ des Kunden, der dem Ereignis zugeordnet ist.

customerValueBucket

enum (CustomerValueBucket)

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

CustomerType

Typ des Kunden, der dem Ereignis zugeordnet 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.