Dies ist die Dokumentation für Recommendations AI, Retail Search und die neue Retail Console. Wenn Sie Retail Search in der eingeschränkten GA-Phase nutzen möchten, wenden Sie sich an den Cloud-Vertrieb.

Wenn Sie Recommendations AI nur verwenden, bleiben Sie in der Recommendations-Konsole und sehen Sie sich die Dokumentation zu Recommendations AI an.

Hinweis

Auf dieser Seite werden die Schritte beschrieben, die Sie vor der Verwendung der Retail API ausführen müssen.

Projekt einrichten

Sie müssen ein Google Cloud-Projekt erstellen, um auf die Retail API zugreifen zu können. So richten Sie ein Projekt ein:

  1. Öffnen Sie in der Cloud Console die Seite Ressourcen verwalten.

    Zur Seite "Ressourcen verwalten"

  2. Wählen Sie oben auf der Seite im Drop-down die Organisation aus, in der Sie ein Projekt erstellen möchten.

  3. Klicken Sie auf Projekt erstellen.

  4. Geben Sie im angezeigten Fenster Neues Projekt einen Projektnamen ein und wählen Sie ggf. ein Rechnungskonto aus.

  5. Wenn Sie das Projekt einem Ordner hinzufügen möchten, geben Sie im Feld Speicherort den Namen des Ordners ein.

  6. Nachdem Sie die Details zum neuen Projekt eingegeben haben, klicken Sie auf Erstellen.

  7. Aktivieren Sie die Retail API für Ihr Google Cloud-Projekt.

    RETAIL API AKTIVIEREN

    Klicken Sie in der Google Cloud Console auf AKTIVIEREN, um die API zu aktivieren.

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 Ihre Anwendung zugreifen kann (siehe your-service-account-json-key-file unter Mit Dienstkonto (OAuth 2.0) authentifizieren).

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 ruft mit dem Befehl gcloud auth application-default print-access-token ein Zugriffstoken für das Dienstkonto mit dem Cloud SDK der Google Cloud Platform (GCP) ab. Informationen zum Herunterladen und Installieren des SDK finden Sie unter Cloud SDK.

  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 im Drop-down-Menü oben auf der Google Cloud Console-Seite 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 mit einem 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();
    }
  }
}

Auf die Retail-Verwaltungskonsole zugreifen

Mit der Retail Console können Sie Retail-Ressourcen verwalten und ihre Aktivität über die browserbasierte Google Cloud Console überwachen.

In der Retail-Verwaltungskonsole finden Sie eine Übersicht über die Möglichkeiten, die die Konsole bietet.

Zur Retail Cloud Console

Nächste Schritte

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