Von der Betaversion zur Retail API migrieren

In den Empfehlungen wird jetzt die Retail API verwendet. Auf dieser Seite werden die eingeführten Änderungen und Best Practices für die Migration beim Wechsel von der v1beta1-Version der Recommendations Engine API (Dienstendpunkt https://recommendationengine.googleapis.com) zur allgemein verfügbaren Retail API (Dienstendpunkt https://retail.googleapis.com) erläutert.

Die Recommendations Engine API und die zugehörige Dokumentation bleiben verfügbar, werden aber nicht mehr aktualisiert.

Dieses Dokument betrifft Sie nur, wenn Sie mit der Verwendung von Empfehlungen begonnen haben, als sie sich in der Betaphase befand.

Best Practices

  • Senden Sie nur validierten Traffic vor der vollständigen Migration.
  • Die inkrementelle Trafficmigration ist besser als die gleichzeitige Umstellung. Migrieren Sie Ihren Traffic nach Möglichkeit schrittweise von v1beta1 zu v2.
  • Wenn Sie Dienste in verschiedenen Regionen ausführen, ist es besser, die Regionen nacheinander zu migrieren, um einen globalen Ausfall zu vermeiden.

Änderungen in der Dokumentation

Nach dem Wechsel zur Retail-Konsole empfehlen wir, ausschließlich diese Retail-Dokumentation unter https://cloud.google.com/retail/docs zu verwenden.

Die Betadokumentation für die Recommendations Engine API bleibt verfügbar, wird aber nicht mehr aktualisiert.

Änderungen in der Console

Die Retail-Konsole ersetzt die Empfehlungskonsole.

Die Google Cloud Console für den Einzelhandel ist seit dem 20. Januar 2022 öffentlich verfügbar. Wenn Sie die Empfehlungskonsole verwenden, empfehlen wir, über die Retail-Konsole auf Ihre Empfehlungsprojekte zuzugreifen.

Eine Erläuterung der Änderungen bei Funktionalität und Terminologie in der Retail-Konsole im Vergleich zur Empfehlungskonsole finden Sie unter Zur Retail-Konsole wechseln.

Katalog- und Nutzerereignisschemas

Die Schemas für Katalog- und Nutzerereignisse wurden in der Retail API geändert.

Bereitstellungskonfigurationen und Placements

Die Retail API führt Bereitstellungskonfigurationen ein, die das Konzept der Placements ersetzen, die von der Recommendations Engine API verwendet werden.

Bereitstellungskonfigurationen sind ab Recommendations v2 und Retail Search v2alpha verfügbar und verwenden die Retail API.

Die Ressource servingConfig ist in den Retail API-Versionen v2beta und v2alpha verfügbar. Sie können diese Ressource zum Erstellen, Ansehen, Bearbeiten und Entfernen von Bereitstellungskonfigurationen verwenden.

Wenn Sie bereits Placements haben oder neue Placements erstellen, erstellt die Retail API automatisch eine Bereitstellungskonfiguration, die mit jedem Placement verknüpft ist. Beim Erstellen einer Bereitstellungskonfiguration wird kein entsprechendes Placement erstellt.

Beim Löschen einer Bereitstellungskonfiguration wird das entsprechende Placement gelöscht. Beim Löschen eines Placements wird auch die entsprechende Bereitstellungskonfiguration gelöscht.

Mithilfe von Bereitstellungskonfigurationen können Sie Optionen für die Diversität und Preis-Reranking bearbeiten und diese nahezu in Echtzeit wirksam werden lassen. Bei Placements können die Einstellungen für Vielfalt und Preise nur in dem Empfehlungsmodell geändert werden, auf das das Placement verweist.

Placements werden weiterhin unterstützt, es wird jedoch empfohlen, stattdessen Auslieferungskonfigurationen zu verwenden.

Weitere Informationen zu Bereitstellungskonfigurationen finden Sie unter Bereitstellungskonfigurationen und Bereitstellungskonfigurationen erstellen.

REST- und RPC-Pfade

An den REST- und RPC-Pfaden wurden viele Änderungen vorgenommen. Lesen Sie die API-Dokumentation für die Retail API, um sicherzustellen, dass Sie die Retail API ordnungsgemäß aufrufen.

Für alle Pfade wird jetzt retail.googleapis.com anstelle von recommendationengine.googleapis.com verwendet.

Beispiel:

v1beta1 Recommendations Engine API: 

GET https://recommendationengine.googleapis.com/v1beta1/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/operations/OPERATION_ID

V2 Retail API:

GET https://retail.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/operations/OPERATION_ID

Einige Ressourcen und Methoden wurden umbenannt, entfernt oder neu hinzugefügt. In der folgenden Tabelle werden v1beta1- und v2-Ressourcen sowie die zugehörigen Methoden nebeneinander verglichen.

Die v1beta1-Ressource catalogs.catalogItems entspricht beispielsweise der v2-Ressource catalogs.branches.products. Die Methode list, die in catalogs.catalogItems für v1beta1 verfügbar war, ist für catalogs.branches.products in v2 nicht verfügbar. Daher wird sie als Entfernt angezeigt.

Links zu v1beta1-Ressourcen finden Sie in der API-Dokumentation für v1beta1.

v1beta1-Ressource Methode v2-Ressource Methode
catalogs list catalogs list
patch patch
– catalogs.branches.operations get
catalogs.catalogItems create catalogs.branches.products create
delete delete
get get
import import
list Entfernt
patch patch
catalogs.operations get catalogs.operations get
list list
catalogs.eventStores.operations get Entfernt
list
catalogs.eventStores.placements predict catalogs.placements predict
catalogs.eventStores.predictionApiKeyRegistrations create Entfernt
delete
list
catalogs.eventStores.userEvents collect catalogs.userEvents collect
import import
list Entfernt
purge purge
rejoin rejoin
write write
– operations get
list

IAM-Änderungen

Die folgenden Änderungen wurden an Rollen und Berechtigungen für die Identitäts- und Zugriffsverwaltung (IAM) für Retail eingeführt:

  • Retail verwendet IAM-Rollen und -Berechtigungen im Namespace retail anstelle des Namespace automlrecommendations, der von Recommendations Engine v1beta1 verwendet wurde.
  • Die Rolle Admin Viewer wurde entfernt.
  • Berechtigungen für apiKeys wurden entfernt, da die predict-Methode keinen eigenen API-Schlüssel mehr benötigt.