Dies ist die Dokumentation für Recommendations AI, Retail Search und die neue Retail Console.

Hinweis

Google Cloud-Projekt erstellen

  1. Wähle in der Cloud Console auf der Seite Ressourcen verwalten ein Google Cloud-Projekt aus oder erstellen Sie eins.

    Zur Seite "Ressourcen verwalten"

  2. Die Abrechnung für das Cloud-Projekt muss aktiviert sein. So überprüfen Sie, ob die Abrechnung für ein Projekt aktiviert ist.

Retail API einrichten

Wenn Sie die Retail API zusammen mit Recommendations AI verwenden möchten, müssen Sie die Retail API aktivieren und die Nutzungsbedingungen zur Datennutzung akzeptieren. Wenn du auch die Einzelhandelssuche verwendest, musst du sie aktivieren. Bei der Verwendung von Retail Search fallen je nach Anzahl der Suchanfragen zusätzliche Kosten an. Weitere Informationen finden Sie unter Gebühren für die Suche im Einzelhandel.

So richten Sie die Retail API ein:

  1. Rufen Sie in der Cloud Console die Seite Einzelhandel auf.

    Zur Seite „Einzelhandel“

  2. Klicken Sie auf der Seite Retail API einrichten auf API aktivieren.

  3. Wenn Retail API und Recommendations AI als Ein angezeigt wird, klicken Sie auf Weiter.

  4. Lesen Sie die Datennutzungsbedingungen für die Retail API und klicken Sie auf Akzeptieren, wenn Sie den Bedingungen für die Datennutzung zustimmen.

    Wenn Sie die Nutzungsbedingungen zur Datennutzung akzeptieren, geben Sie in der Cloud Console an, dass die Nutzungsbedingungen der Retail API akzeptiert werden.

  5. Wenn Sie das Projekt nur mit Recommendations AI verwenden möchten, klicken Sie auf Get Started (Jetzt starten).

  6. Wenn Sie die Einzelhandelssuche zusätzlich zu Recommendations AI aktivieren möchten, gehen Sie so vor:

    1. Klicke auf Weiter und dann auf der Seite Einzelhandelssuche aktivieren (optional) auf Aktivieren.
    2. Klicken Sie auf Jetzt starten.

In der Cloud Console werden die von dir aktivierten Retail API-Komponenten angezeigt. Du kannst jetzt die Anfangseinstellungen deines Projekts konfigurieren.

Retail API für ein vorhandenes Projekt einrichten

Wenn Sie die Retail API für ein Google Cloud-Projekt eingerichtet haben, bevor die Datenverarbeitungsbedingungen am 4. April 2022 in Kraft getreten sind, müssen Sie die Nutzungsbedingungen von Discovery Solutions akzeptieren, um die Retail API mit diesem Projekt weiterhin verwenden zu können. Außerdem müssen Sie die Einzelhandelssuche für dieses Projekt aktivieren.

So akzeptieren Sie die Nutzungsbedingungen für Discovery-Daten in einem vorhandenen Projekt:

  1. Rufen Sie in der Cloud Console die Seite Einzelhandel für Ihr Projekt auf.

    Zur Seite „Einzelhandel“

  2. Lesen Sie auf der Seite Datennutzungsbedingungen die Nutzungsbedingungen für Discovery-Lösungen und klicken Sie auf Akzeptieren, wenn Sie den Bedingungen zustimmen.

  3. Wenn Sie das Projekt nur mit Recommendations AI verwenden möchten, klicken Sie auf Get Started (Jetzt starten).

  4. Wenn Sie die Einzelhandelssuche zusätzlich zu Recommendations AI aktivieren möchten, gehen Sie so vor:

    1. Klicke auf Weiter und dann auf der Seite Einzelhandelssuche aktivieren (optional) auf Aktivieren.
    2. Klicken Sie auf Jetzt starten.

Retail Search oder Retail API deaktivieren

Retail Search deaktivieren

Wenn Sie die Retail-Suche nicht mehr verwenden möchten, können Sie sie deaktivieren, indem Sie ein Support-Ticket einreichen.

Um die richtige Komponente für Ihr Ticket festzulegen, wählen Sie die folgenden Felder aus:

  • Kategorie: Maschinelles Lernen
  • Komponente: Retail Solutions: Retail Search
  • Unterkomponente: Kontoverwaltung und Abrechnung

Weitere Informationen zum Erstellen eines Support-Tickets finden Sie unter Support erhalten.

Retail API deaktivieren

Sie können die Retail API jederzeit deaktivieren, indem Sie sie und Recommendations AI deaktivieren. Dadurch wird auch die Einzelhandelssuche deaktiviert.

So deaktivieren Sie die Retail API:

  1. Rufen Sie in der Cloud Console die Seite Retail API-Dienstdetails auf.

    Zur Seite „Details zum Retail API-Dienst“

  2. Klicken Sie auf API deaktivieren.

  3. Klicken Sie im Feld Retail API deaktivieren? auf Deaktivieren.

  4. Klicken Sie im Feld Recommendations AI deaktivieren? auf Deaktivieren.

Erste Schritte mit der Retail API

Wenn Sie die Retail API für ein neues Projekt einrichten, werden in der Google Cloud Console die folgenden drei Bereiche angezeigt, mit denen Sie Ihr Retail API-Projekt konfigurieren können:

  • Katalog: Zeigt Ihren Produktkatalog und einen Link zum Importieren Ihres Katalogs an.

  • Ereignis:: Zeigt Ihre Nutzerereignisse und einen Link zum Importieren bisheriger Nutzerereignisse an

  • Konfigurationen für die Bereitstellung: Enthält Details zur Bereitstellungskonfiguration und einen Link zum Erstellen einer neuen Bereitstellungskonfiguration.

Mit diesen Bereichen können Sie Ihre Daten importieren und eine Anfangskonfiguration für Ihr Retail API-Projekt erstellen.

Produktkatalog importieren

Führen Sie die Schritte für Ihre Datenquelle aus, um Ihren Produktkatalog zu importieren. Weitere Informationen zu Produktkatalogen finden Sie unter Kataloginformationen importieren.

Merchant Center-Synchronisierung

  1. Klicken Sie auf Produktkatalog importieren, um das Steuerfeld Daten importieren zu öffnen.
  2. Wählen Sie Produktkatalog aus.
  3. Wählen Sie Merchant Center Sync als Datenquelle aus.
  4. Wählen Sie Ihr Merchant Center-Konto aus.
  5. Wählen Sie den Zweig aus, in den Sie Ihren Katalog hochladen.
  6. Klicken Sie auf Importieren.

Cloud Storage

  1. Klicken Sie auf Produktkatalog importieren, um das Steuerfeld Daten importieren zu öffnen.
  2. Wählen Sie Produktkatalog als Datenquelle aus.
  3. Wählen Sie den Zweig aus, in den Sie Ihren Katalog hochladen.
  4. Wählen Sie als Schema Retail Product Catalogs aus.
  5. Geben Sie den Cloud Storage-Speicherort Ihrer Daten ein.
  6. Wenn du die Einzelhandelssuche nicht aktiviert hast, wähle die Produktebenen aus.

    Wenn du deinen Katalog zum ersten Mal importieren oder ihn nach dem dauerhaften Löschen wieder importieren möchtest, musst du die Produktebenen auswählen. Weitere Informationen zu Produktebenen. Das Ändern der Produktebenen nach dem Import von Daten ist erheblich aufwendig.

    Wichtig:Sie können die Einzelhandelssuche nicht für Projekte mit einem Produktkatalog aktivieren, der als Varianten aufgenommen wurde.
  7. Klicken Sie auf Importieren.

BigQuery

  1. Klicken Sie auf Produktkatalog importieren, um das Steuerfeld Daten importieren zu öffnen.
  2. Wählen Sie Produktkatalog aus.
  3. Wählen Sie BigQuery als Datenquelle aus.
  4. Wählen Sie den Zweig aus, in den Sie Ihren Katalog hochladen.
  5. Wählen Sie eines der folgenden Schemas aus:
  6. Geben Sie die BigQuery-Tabelle an, wo sich die Daten befinden.
  7. Optional: Geben Sie unter Erweiterte Optionen einblenden den Speicherort eines Cloud Storage-Buckets in Ihrem Projekt als temporären Speicherort für Ihre Daten ein.

    Wenn nicht angegeben, wird ein Standardspeicherort verwendet. Wenn angegeben, müssen sich der BigQuery- und der Cloud Storage-Bucket in derselben Region befinden.
  8. Wenn du die Einzelhandelssuche nicht aktiviert hast und das Merchant Center-Schema verwendest, musst du die Produktebene auswählen.

    Du musst die Produktebene auswählen, wenn du deinen Katalog zum ersten Mal importiert oder wenn du den Katalog nach dem Löschen noch einmal importieren möchtest. Weitere Informationen zu Produktebenen. Das Ändern der Produktebenen nach dem Import von Daten ist erheblich aufwendig.

    Wichtig:Sie können die Einzelhandelssuche nicht für Projekte mit einem Produktkatalog aktivieren, der als Varianten aufgenommen wurde.
  9. Klicken Sie auf Importieren.

Bisherige Nutzerereignisse importieren

Führen Sie die Schritte für die Datenquelle aus, um bisherige Nutzerereignisse zu importieren. Weitere Informationen zu bisherigen Nutzerereignissen finden Sie unter Bisherige Nutzerereignisse importieren.

Cloud Storage

  1. Klicken Sie auf Nutzerereignisse importieren, um den Bereich Daten importieren zu öffnen.
  2. Wählen Sie Nutzerereignisse aus.
  3. Wählen Sie Google Cloud Storage als Datenquelle aus.
  4. Wählen Sie als Schema Einzelhandels-Nutzerereignisse aus.
  5. Geben Sie den Cloud Storage-Speicherort Ihrer Daten ein.
  6. Klicken Sie auf Importieren.

BigQuery

  1. Klicken Sie auf Nutzerereignisse importieren, um den Bereich Daten importieren zu öffnen.
  2. Wählen Sie Nutzerereignisse aus.
  3. Wählen Sie BigQuery als Datenquelle aus.
  4. Wählen Sie als Schema Einzelhandels-Nutzerereignisse aus.
  5. Geben Sie die BigQuery-Tabelle an, wo sich die Daten befinden.
  6. (Optional) Geben Sie den Speicherort eines Cloud Storage-Buckets in Ihrem Projekt als temporären Speicherort für Ihre Daten ein.
    Falls nicht angegeben, wird ein Standardspeicherort verwendet. Wenn angegeben, müssen sich der BigQuery- und der Cloud Storage-Bucket in derselben Region befinden.
  7. Optional: Geben Sie unter Erweiterte Optionen einblenden den Speicherort eines Cloud Storage-Buckets in Ihrem Projekt als temporären Speicherort für Ihre Daten ein.

    Wenn nicht angegeben, wird ein Standardspeicherort verwendet. Wenn angegeben, müssen sich der BigQuery- und der Cloud Storage-Bucket in derselben Region befinden.
  8. Klicken Sie auf Importieren.

Bereitstellungskonfiguration erstellen

Eine Bereitstellungskonfiguration ist eine Bereitstellungseinheit, die ein Modell oder eine Gruppe von Steuerelementen verknüpft, die zum Generieren von Such- oder Empfehlungsergebnissen verwendet werden.

So erstellen Sie eine Bereitstellungskonfiguration:

  1. Klicken Sie im Steuerfeld Auslieferungskonfigurationen auf Konfiguration für die Anzeigenbereitstellung erstellen.
  2. Wählen Sie auf der Seite Bereitstellungskonfiguration erstellen die Option Suche als Produkt aus, in dem die Bereitstellungskonfiguration verwendet werden soll.
  3. Geben Sie einen Namen für die Bereitstellungskonfiguration ein.

    Der Name darf maximal 1.024 Zeichen lang sein und darf nur alphanumerische Zeichen, Unterstriche, Bindestriche und Leerzeichen enthalten.
  4. Optional: Aktualisieren Sie die ID.

    Die ID wird anhand des von Ihnen angegebenen Namens generiert und muss in Ihrem Projekt eindeutig sein. Er darf nicht länger als 50 Zeichen sein und darf keine Leerzeichen enthalten.
  5. Klicken Sie auf Weiter.
  6. Wählen Sie aus, ob die dynamische Attribute für diese Bereitstellungskonfiguration aktiviert werden sollen.
  7. Wählen Sie Steuerelemente zur Anzeigenbereitstellung aus oder erstellen Sie sie, um Ihre Suchanfragen zu optimieren.

    Weitere Informationen zu Steuerelementen finden Sie unter Steuerelemente erstellen und verwalten.

Dashboard für den Einzelhandel

Wenn Sie die Erstkonfiguration Ihres Projekts abgeschlossen haben, wird in der Retail Console der Systemstatus Ihres Retail API-Projekts angezeigt. Mit der Retail Console können Sie Ressourcen im Einzelhandel verwalten und ihre Aktivitäten beobachten.

Zur Cloud Console für den Einzelhandel

Weitere Informationen zur Einzelhandelskonsole finden Sie unter Retail-Verwaltungskonsole.

Authentifizierung für Ihre Anwendung einrichten

Sie müssen beide Authentifizierungsmethoden einrichten, um auf die Retail API zugreifen zu können:

  • Dienstkonto: Anwendungen verwenden ein Dienstkonto, um Aufrufe an Product zu authentifizieren.

  • API-Schlüssel: Anwendungen verwenden einen API-Schlüssel für Aufrufe an Nutzerereignis-Logging APIs.

Dienstkonto erstellen

  1. Rufen Sie in der Cloud Console die Seite Anmeldedaten auf.

  2. Wählen Sie das Projekt aus, für das Sie Anmeldedaten erstellen (das Projekt ist möglicherweise bereits ausgewählt).

  3. Klicken Sie auf Anmeldedaten erstellen und wählen Sie Dienstkontoschlüssel aus.

  4. Füllen Sie die folgenden Felder aus:

    Feld Wert
    Dienstkonto Neues Dienstkonto
    Name des Dienstkontos enter a name for your service account
    Rolle Dienstkonten > Ersteller von Dienstkonto-Token
    Retail > Retail-Bearbeiter
    Schlüsseltyp JSON
  5. Klicken Sie auf Erstellen, um das Dienstkonto zu erstellen.

    Die JSON-Datei mit dem öffentlichen/privaten Schlüssel für das neue Dienstkonto wird automatisch auf Ihren Computer heruntergeladen. Diese JSON-Datei ist die einzige Kopie des Schlüssels für Ihr Dienstkonto. Bewahren Sie sie an einem sicheren Ort auf. Die JSON-Schlüsseldatei muss an einem Ort gespeichert werden, auf den von deiner Anwendung aus zugegriffen werden kann (siehe your-service-account-json-key-filein Mit einem Dienstkonto authentifizieren (OAuth 2.0).

Dienstkonto der lokalen Umgebung hinzufügen

Wenn Sie die Search for Retail API über das cURL-Befehlszeilentool aufrufen möchten, müssen Sie Ihr Dienstkonto in Ihrer lokalen Umgebung verfügbar machen. cURL verwendet den Befehl gcloud auth application-default print-access-token, um ein Zugriffstoken für das Dienstkonto mithilfe der Google Cloud CLI abzurufen. Informationen zum Herunterladen und Installieren der gcloud-Befehlszeile finden Sie unter gcloud-Befehlszeile. Wenn Sie die Cloud Shell verwenden, ist die gcloud-Befehlszeile bereits installiert.

Die Umgebungsvariable GOOGLE_APPLICATION_CREDENTIALS ist nicht mehr sichtbar, wenn Sie das Befehlsfenster schließen. Legen Sie den Wert in einem Initialisierungs-Shell-Skript fest, damit die Variable auf den Pfad zu Ihrer Dienstkontodatei festgelegt ist, wenn Sie ein neues Befehlsfenster öffnen.

  export GOOGLE_APPLICATION_CREDENTIALS=path-to-service-account-json-key-file

API-Schlüssel erstellen

  1. Rufen Sie in der Cloud Console die Seite Anmeldedaten auf.

  2. Wählen Sie oben auf der Seite der Google Cloud Console im Projekt-Drop-down-Menü Ihr Projekt aus (das Projekt ist möglicherweise bereits ausgewählt).

  3. Klicken Sie auf Anmeldedaten erstellen und wählen Sie anschließend API-Schlüssel aus. Fügen Sie keine Verweiseinschränkungen hinzu. Einige Datenschutzeinstellungen für Nutzer übergeben die Verweis-URL nicht.

    • Notieren Sie sich den generierten API-Schlüssel, da Sie ihn beim Aufrufen des Nutzerereignis-Loggings verwenden.
  4. Für mehr Sicherheit fügen Sie Ihrem API-Schlüssel eine HTTP-Einschränkung hinzu, um den Zugriff auf den Retail-Dienst unter https://retail.googleapis.com/* einzuschränken.

Beispiele

Authentifizierung über ein Dienstkonto (OAuth 2.0)

Im Folgenden finden Sie ein Java-Beispiel für die OAuth 2.0-Authentifizierung mit einem Dienstkonto. Eine ausführlichere Anleitung finden Sie in der Authentifizierungsdokumentation. Google verfügt über Clientbibliotheken in 7 Sprachen, mit denen Sie die OAuth2-Authentifizierung in Ihrer Anwendung implementieren können. Wenn Sie das HTTP/REST-Modul direkt implementieren möchten, folgen Sie der Anleitung zur REST-Authentifizierung.

Ersetzen Sie im Beispiel your-service-account-json-key-file durch den Pfad zur JSON-Schlüsseldatei für Ihr Dienstkonto.

// Simple Java example of using Google Cloud OAuth client library.
//
// Please see here for the list of libraries in different languages:
// https://developers.google.com/identity/protocols/OAuth2#libraries
//
// The following example depends on the google api client library.
//
// Maven:
//    <dependency>
//      <groupId>com.google.api-client</groupId>
//      <artifactId>google-api-client</artifactId>
//      <version>1.22.0</version>
//    </dependency>
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestFactory;
import com.google.api.client.http.HttpResponse;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.json.JsonHttpContent;
import com.google.api.client.json.GenericJson;
import com.google.api.client.json.jackson2.JacksonFactory;
import java.io.FileInputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

public class RetailApiSample {
  public static final String CREATE_PRODUCT_URL =
     "https://retail.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/branches/0/products";

  public static GoogleCredential authorize() throws Exception {
    return GoogleCredential.fromStream(new FileInputStream("your-service-account-json-key-file"))
        .createScoped(Collections.singleton("https://www.googleapis.com/auth/cloud-platform"))
        .setExpirationTimeMilliseconds(new Long(3600 * 1000));;
  }

  // Build an example product.
  public static GenericJson getProduct() {
    GenericJson categories = new GenericJson()
        .set("categories", Arrays.asList("Electronics > Computers", "Laptops"));
    GenericJson priceInfo = new GenericJson()
        .set("currency_code", "USD")
        .set("price", 800.00)
        .set("original_price", 1000.00);

    return new GenericJson()
        .set("name", "projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/branches/0/products/[ProductName]")
        .set("title", "Sample Laptop")
        .set("description", "Indisputably the most fantastic laptop ever created.")
        .set("categories", categories)
        .set("price_info", priceInfo)
        .set("availability", "IN_STOCK")
        .set("available_quantity", 1219);
  }

  public static void main(String[] args) {
    try {
      GoogleCredential credential = RetailApiSample.authorize();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      HttpRequestFactory requestFactory = httpTransport.createRequestFactory();
      HttpRequest request = requestFactory.buildPostRequest(new GenericUrl(CREATE_PRODUCT_URL),
          new JsonHttpContent(new JacksonFactory(), RetailApiSample.getProduct()));
      credential.initialize(request);
      HttpResponse response = request.execute();
      System.out.println("Response content: " + response.parseAsString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Weitere Informationen

  • Unter Retail API implementieren finden Sie eine detaillierte Übersicht darüber, was Sie tun müssen, um die Retail API zu implementieren.