- Ressource: UserEvent
- UserInfo
- PageInfo
- DocumentInfo
- PanelInfo
- SearchInfo
- CompletionInfo
- TransactionInfo
- MediaInfo
- Methoden
Ressource: UserEvent
Mit UserEvent werden alle Metadaten erfasst, die für die Discovery Engine API erforderlich sind, um zu erfahren, wie Endnutzer mit Ihrer Website interagieren.
JSON-Darstellung |
---|
{ "eventType": string, "conversionType": string, "userPseudoId": string, "engine": string, "dataStore": string, "eventTime": string, "userInfo": { object ( |
Felder | |
---|---|
eventType |
Erforderlich. Nutzerereignistyp. Zulässige Werte sind: Generische Werte:
Einzelhandelsbezogene Werte:
Media-bezogene Werte:
Benutzerdefinierter Conversion-Wert:
|
conversionType |
Optional. Conversion-Typ Erforderlich, wenn Legen Sie das Feld nicht fest, wenn |
userPseudoId |
Erforderlich. Eine eindeutige Kennung für das Tracking von Besuchern. Dies kann beispielsweise mit einem HTTP-Cookie implementiert werden, mit dem ein Besucher auf einem einzelnen Gerät eindeutig identifiziert werden kann. Diese eindeutige ID sollte sich nicht ändern, wenn sich der Besucher auf der Website an- oder abmeldet. Legen Sie für verschiedene Nutzer nicht dieselbe feste ID für das Feld fest. Dadurch wird der Ereignisverlauf dieser Nutzer vermischt, was zu einer geringeren Modellqualität führt. Das Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler Das Feld darf keine personenidentifizierbaren Informationen oder Nutzerdaten enthalten. Wir empfehlen, für dieses Feld die Client-ID von Google Analytics zu verwenden. |
engine |
Der Ressourcenname von Optional. Nur für von |
dataStore |
Der vollständige Name der Optional. Nur für Nutzerereignisse erforderlich, deren Datenspeicher nicht durch |
eventTime |
Nur für die Methode 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: |
userInfo |
Informationen zum Endnutzer. |
directUserRequest |
Sollte auf „true“ gesetzt werden, wenn die Anfrage direkt vom Endnutzer gestellt wird. In diesem Fall kann Dieses Flag sollte nur gesetzt werden, wenn die API-Anfrage direkt vom Endnutzer, z. B. über eine mobile App, erfolgt und nicht, wenn ein Gateway oder ein Server die Nutzerereignisse verarbeitet und überträgt. Dieser Wert sollte nicht festgelegt werden, wenn das JavaScript-Tag in |
sessionId |
Eine eindeutige Kennung zum Tracking einer Besuchersitzung mit einer Längenbeschränkung von 128 Byte. Eine Sitzung ist eine Zusammenfassung des Endnutzerverhaltens in einem bestimmten Zeitraum. Allgemeine Richtlinie zum Ausfüllen der „sessionId“:
|
pageInfo |
Seitenmetadaten wie Kategorien und andere wichtige Informationen für bestimmte Ereignistypen wie |
attributionToken |
Token zum Zuordnen einer API-Antwort zu Nutzeraktionen, die das Ereignis auslösen. Für Nutzerereignisse, die das Ergebnis von Der Wert muss einer der folgenden sein:
Mit diesem Token können wir Seitenaufrufe oder Conversion-Abschlüsse dem Ereignis und der jeweiligen Vorhersageantwort zuordnen, die dieses angeklickte/gekaufte Produkt enthält. Wenn ein Nutzer in den Empfehlungsergebnissen auf Produkt K klickt, übergeben Sie |
filter |
Die Filtersyntax besteht aus einer Ausdruckssprache zum Erstellen eines Prädikats aus einem oder mehreren Feldern der gefilterten Dokumente. Bei Bei Der Wert muss ein UTF‑8-codierter String mit einer Längenbeschränkung von 1.000 Zeichen sein. Andernfalls wird der Fehler |
documents[] |
Liste der Dieses Feld ist mit Ausnahme der folgenden Ereignistypen optional:
Bei einem |
panel |
Panel-Metadaten, die mit diesem Nutzerereignis verknüpft sind. |
searchInfo |
Dieses Feld sollte für das Ereignis |
completionInfo |
Dieses Feld sollte für das |
transactionInfo |
Die mit diesem Nutzerereignis verknüpften Transaktionsmetadaten (falls vorhanden). |
tagIds[] |
Eine Liste mit Kennungen für die unabhängigen Testgruppen, zu denen dieses Nutzerereignis gehört. Damit wird zwischen Nutzerereignissen unterschieden, die mit verschiedenen Testkonfigurationen verknüpft sind. |
promotionIds[] |
Die Promotions-IDs, wenn es sich um ein Ereignis handelt, das mit Promotions verknüpft ist. Derzeit ist dieses Feld auf maximal eine ID beschränkt. |
attributes |
Zusätzliche Nutzerereignis-Features, die in das Empfehlungsmodell aufgenommen werden sollen. Diese Attribute dürfen KEINE Daten enthalten, die weiter analysiert oder verarbeitet werden müssen, z.B. JSON oder andere Codierungen. Wenn Sie benutzerdefinierte Attribute für aufgenommene Nutzerereignisse angeben, müssen Sie sie auch in die Nutzerereignisse einbeziehen, die Sie mit Vorhersageanfragen verknüpfen. Die Formatierung benutzerdefinierter Attribute muss zwischen importierten Ereignissen und Ereignissen, die mit Vorhersageanfragen bereitgestellt werden, einheitlich sein. So kann die Discovery Engine API diese benutzerdefinierten Attribute beim Trainieren von Modellen und Bereitstellen von Vorhersagen verwenden, was die Qualität der Empfehlungen verbessert. Dieses Feld muss alle unten aufgeführten Kriterien erfüllen, andernfalls wird ein
Ein Beispiel für zusätzliche Nutzerinformationen für Produktempfehlungen ist |
attributes.text[] |
Die Textwerte dieses benutzerdefinierten Attributs. Beispiel: Ein leerer String ist nicht zulässig. Andernfalls wird der Fehler Es sollte genau eines von |
attributes.numbers[] |
Die numerischen Werte dieses benutzerdefinierten Attributs. Beispiel: Es sollte genau eines von |
mediaInfo |
Medienspezifische Informationen |
panels[] |
Optional. Liste der Panels, die mit diesem Ereignis verknüpft sind. Wird für Impressionen auf Seitenebene verwendet. |
UserInfo
Informationen eines Endnutzers.
JSON-Darstellung |
---|
{ "userId": string, "userAgent": string, "timeZone": string } |
Felder | |
---|---|
userId |
Für angemeldete Nutzer dringend empfohlen. Eindeutige Kennung für den angemeldeten Nutzer, z. B. ein Nutzername. Nicht für anonyme Nutzer festlegen. Verwenden Sie immer einen gehashten Wert für diese ID. Legen Sie für verschiedene Nutzer nicht dieselbe feste ID für das Feld fest. Dadurch wird der Ereignisverlauf dieser Nutzer vermischt, was zu einer geringeren Modellqualität führt. Das Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 128 Zeichen sein. Andernfalls wird der Fehler |
userAgent |
User-Agent, wie im HTTP-Header enthalten. Das Feld muss ein UTF-8-codierter String mit einer Längenbeschränkung von 1.000 Zeichen sein. Andernfalls wird der Fehler Dieser Wert sollte nicht festgelegt werden, wenn Sie die clientseitige Ereignisberichterstellung mit GTM oder dem JavaScript-Tag in |
timeZone |
Optional. IANA-Zeitzone, z.B. Europe/Budapest. |
PageInfo
Detaillierte Seiteninformationen.
JSON-Darstellung |
---|
{ "pageviewId": string, "pageCategory": string, "uri": string, "referrerUri": string } |
Felder | |
---|---|
pageviewId |
Eine eindeutige ID einer Webseitenaufrufs. Dieser Wert sollte für alle Nutzerereignisse, die durch denselben Seitenaufruf ausgelöst werden, gleich bleiben. Ein Aufruf der Detailseite eines Artikels kann beispielsweise mehrere Ereignisse auslösen, während der Nutzer die Seite durchsucht. Die Wenn Sie die clientseitige Ereignisberichterstellung mit JavaScript-Pixel und Google Tag Manager verwenden, wird dieser Wert automatisch ausgefüllt. |
pageCategory |
Die spezifischste Kategorie, die einer Kategorieseite zugeordnet ist. Verwenden Sie das Zeichen „>“, um verschiedene Hierarchien zu trennen und den vollständigen Pfad der Kategorie darzustellen. Wenn „>“ Teil des Kategorienamens ist, ersetzen Sie es durch andere Zeichen. Kategorieseiten umfassen spezielle Seiten wie Verkaufs- oder Werbeaktionsseiten. Eine spezielle Angebotsseite kann beispielsweise die Kategoriehierarchie Erforderlich für |
uri |
Vollständige URL (window.location.href) der aktuellen Seite des Nutzers. Wenn Sie die clientseitige Ereignisberichterstellung mit JavaScript-Pixel und Google Tag Manager verwenden, wird dieser Wert automatisch ausgefüllt. Maximale Länge: 5.000 Zeichen. |
referrerUri |
Die Referrer-URL der aktuellen Seite. Wenn Sie die clientseitige Ereignisberichterstellung mit JavaScript-Pixel und Google Tag Manager verwenden, wird dieser Wert automatisch ausgefüllt. Aufgrund von Datenschutzbeschränkungen in einigen Browsern kann dieses Feld jedoch leer sein. |
DocumentInfo
Detaillierte Dokumentinformationen, die mit einem Nutzerereignis verknüpft sind.
JSON-Darstellung |
---|
{ "promotionIds": [ string ], "joined": boolean, // Union field |
Felder | |
---|---|
promotionIds[] |
Die mit diesem Dokument verknüpften Angebots-IDs. Derzeit ist dieses Feld auf maximal eine ID beschränkt. |
joined |
Nur Ausgabe. Gibt an, ob das referenzierte Dokument im Datenspeicher gefunden werden kann. |
Union-Feld
|
|
id |
Die Ressourcen-ID von |
name |
Der vollständige Name der |
uri |
Der |
quantity |
Menge des Dokuments, das mit dem Nutzerereignis verknüpft ist. Der Standardfaktor ist 1. Dieser Wert ist beispielsweise „2“, wenn bei einem Erforderlich für Ereignisse der folgenden Ereignistypen:
|
conversionValue |
Optional. Der mit diesem Dokument verknüpfte Conversion-Wert. Muss festgelegt werden, wenn Ein Wert von 1.000 bedeutet beispielsweise, dass ein Dokument für den Conversion-Typ |
PanelInfo
Detaillierte Informationen zum Panel, das einem Nutzerereignis zugeordnet ist.
JSON-Darstellung |
---|
{
"panelId": string,
"displayName": string,
"documents": [
{
object ( |
Felder | |
---|---|
panelId |
Erforderlich. Die Bereichs-ID. |
displayName |
Der Anzeigename des Bereichs. |
documents[] |
Optional. Die mit diesem Bereich verknüpften Dokument-IDs. |
panelPosition |
Die geordnete Position des Felds, wenn es dem Nutzer zusammen mit anderen Feldern angezeigt wird. Wenn dieser Wert festgelegt ist, muss auch |
totalPanels |
Die Gesamtzahl der Bereiche, einschließlich dieses, die dem Nutzer angezeigt wurden. Muss festgelegt werden, wenn |
SearchInfo
Detaillierte Suchinformationen
JSON-Darstellung |
---|
{ "searchQuery": string, "orderBy": string, "offset": integer } |
Felder | |
---|---|
searchQuery |
Die Suchanfrage des Nutzers. Eine Definition finden Sie unter Der Wert muss ein UTF‑8-codierter String mit einer Längenbeschränkung von 5.000 Zeichen sein. Andernfalls wird der Fehler Für |
orderBy |
Die Reihenfolge, in der Produkte zurückgegeben werden (falls zutreffend). Definition und Syntax finden Sie unter Der Wert muss ein UTF‑8-codierter String mit einer Längenbeschränkung von 1.000 Zeichen sein. Andernfalls wird der Fehler Dieser Wert kann nur für |
offset |
Eine Ganzzahl, die den aktuellen Offset für die Paginierung angibt (die 0-basierte Startposition unter den Produkten, die von der API als relevant eingestuft werden). Eine Definition finden Sie unter Wenn dieses Feld negativ ist, wird ein Dieser Wert kann nur für |
CompletionInfo
Detaillierte Informationen zum Abschluss, einschließlich des Attributions-Tokens für den Abschluss und der Informationen zum angeklickten Abschluss.
JSON-Darstellung |
---|
{ "selectedSuggestion": string, "selectedPosition": integer } |
Felder | |
---|---|
selectedSuggestion |
Endnutzer |
selectedPosition |
Die vom Endnutzer ausgewählte Position |
TransactionInfo
Eine Transaktion umfasst die gesamte Kauftransaktion.
JSON-Darstellung |
---|
{ "currency": string, "transactionId": string, "value": number, "tax": number, "cost": number, "discountValue": number } |
Felder | |
---|---|
currency |
Erforderlich. Währungscode. Verwenden Sie den dreistelligen ISO‑4217-Code. |
transactionId |
Die Transaktions-ID mit einer Längenbeschränkung von 128 Zeichen. |
value |
Erforderlich. Der Gesamtwert der Transaktion, der nicht null ist. Der Wert kann Versandkosten, Steuern und andere Anpassungen des Gesamtwerts enthalten, die berücksichtigt werden sollen. |
tax |
Alle Steuern, die mit der Transaktion verbunden sind. |
cost |
Alle Kosten, die mit den Produkten verbunden sind. Dazu können Fertigungskosten, Versandkosten, die nicht vom Endnutzer getragen werden, oder andere Kosten gehören, sodass gilt: |
discountValue |
Der Gesamtwert der Rabatte, die auf diese Transaktion angewendet wurden. Diese Zahl sollte aus Wenn ein Nutzer beispielsweise den Betrag Das bedeutet, dass der Gewinn unabhängig vom Rabattwert auf dieselbe Weise berechnet wird und |
MediaInfo
Medienspezifische Nutzerereignisinformationen
JSON-Darstellung |
---|
{ "mediaProgressDuration": string, "mediaProgressPercentage": number } |
Felder | |
---|---|
mediaProgressDuration |
Die Zeit, die seit Beginn der Wiedergabe vergangen ist, in Sekunden (falls zutreffend). Wenn der Endnutzer beispielsweise 90 Sekunden eines Wiedergabevideos angesehen hat, sollte Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit " |
mediaProgressPercentage |
Der Fortschritt von Media sollte nur anhand von Dieser Wert muss zwischen Wenn es sich nicht um eine Wiedergabe handelt oder der Fortschritt nicht berechnet werden kann (z.B. bei einem laufenden Livestream), sollte dieses Feld nicht festgelegt werden. |
Methoden |
|
---|---|
|
Schreibt ein einzelnes Nutzerereignis aus dem Browser. |
|
Bulk-Import von Nutzerereignissen |
|
Löscht alle Nutzerereignisse, die durch den angegebenen Filter definiert werden, dauerhaft. |
|
Schreibt ein einzelnes Nutzerereignis. |