Kompatibilität der Content API für Shopping

Anhand dieses Leitfadens können Sie die Merchant API in Ihre bestehende Content API for Shopping-Implementierung einbinden.

Erste Schritte

Weitere Informationen zur Merchant API und ihren Unter-APIs findest du unter Merchant API-Design.

Um die Merchant API zu verwenden, ändern Sie Ihre Anfrage-URLs in das folgende Format:

https://merchantapi.googleapis.com/{sub-API}/{version}/{resource name}/{service}:{method}

Weitere Informationen finden Sie in der Kurzanleitung und in der Referenz zur Merchant API.

gRPC-Unterstützung

Die Merchant API unterstützt gRPC und REST. Sie können gRPC für die Merchant API und REST für die Content API for Shopping gleichzeitig verwenden.

Die Merchant API-Clientbibliotheken erfordern gRPC.

Weitere Informationen finden Sie unter gRPC verwenden.

Kompatibilität

In diesem Leitfaden werden allgemeine Änderungen beschrieben, die für die gesamte Merchant API gelten. Informationen zu Änderungen an bestimmten Funktionen finden Sie in den folgenden Leitfäden:

Die Merchant API kann zusammen mit den vorhandenen Funktionen der Content API for Shopping 2.1 verwendet werden.

Du kannst beispielsweise die Merchant Inventories API zusammen mit deinem Inventar in der Content API for Shopping 2.1 und der Implementierung von products verwenden. Sie können die Content API for Shopping verwenden, um ein neues lokales Produkt hochzuladen, das Sie in einem lokalen Geschäft verkaufen, und dann mit der Merchant Inventories API-Ressource LocalInventory Informationen zum Geschäft für dieses Produkt verwalten.

Batchanfragen

Die Merchant API unterstützt die customBatch-Methode der Content API for Shopping nicht. Weitere Informationen finden Sie unter Batchanfragen senden. Wenn Sie customBatch verwenden und dieses Feature für die Merchant API benötigen, teilen Sie uns in Ihrem Feedback den Grund dafür mit.

IDs

Um den API-Verbesserungsprinzipien von Google zu entsprechen, haben wir einige Änderungen an den Kennungen für Merchant API-Ressourcen vorgenommen.

Name ersetzt ID

Alle Merchant API-Ressourcen verwenden das Feld name als eindeutige Kennung.

Hier ein Beispiel für die Verwendung des Felds name in Ihren Aufrufen:

POST https://merchantapi.googleapis.com/inventories/v1beta/{parent}/regionalInventories:insert

Das neue Feld name wird als Ressourcen-ID für alle Lese- und Schreibaufrufe in der Merchant API zurückgegeben.

Der in name-Feldern zurückgegebene Wert verwendet das neue ID-Format.

Implementieren Sie beispielsweise eine getName()-Methode, um die name aus einer Ressource abzurufen und die Ausgabe als Variable zu speichern, anstatt die name selbst aus den Händler- und Ressourcen-IDs zu erstellen.

Neues ID-Format

In der Merchant API haben Ressourcen-IDs das folgende Format: channel~language~feedLabel~offerId

Content API-Ressourcen haben : statt ~ zwischen den einzelnen Werten in der ID verwendet: channel:language:feedLabel:offerId

Bei allen Merchant API-Aufrufen wird das neue Format mit ~ zwischen den ID-Werten zurückgegeben. Wir empfehlen, das neue Format aus der Antwort zu speichern und bei zukünftigen Aufrufen zu verwenden.

Übergeordnete Felder für untergeordnete Ressourcen

In der Merchant API haben alle untergeordneten Ressourcen das Feld parent. Sie können im Feld parent die name der Ressource angeben, in die das untergeordnete Element eingefügt werden soll, anstatt die gesamte übergeordnete Ressource zu übergeben. Sie können das Feld parent auch mit list-Methoden verwenden, um die untergeordneten Ressourcen von parent aufzulisten.

Wenn Sie beispielsweise lokale Inventare für ein bestimmtes Produkt auflisten möchten, geben Sie für die Methode list den name des Produkts im Feld parent an. In diesem Fall ist die angegebene product der parent der zurückgegebenen Ressourcen vom Typ LocalInventory.

Typen

Im Folgenden sind einige gängige Typen aufgeführt, die in den Unter-APIs der Merchant API gemeinsam genutzt werden.

Preis

Folgendes hat sich für Price im Merchant Common-Paket geändert:

Content API Händler-API
Feld „Betrag“ value:string amountMicros:int64
Währungsfeld currency:string currencyCode:string

Der Price-Betrag wird jetzt in Mikros erfasst, wobei 1 Million Mikros der Standardeinheit Ihrer Währung entspricht.

In der Content API for Shopping war Price eine Dezimalzahl in Form eines Strings.

Der Name des Betragsfelds wurde von value in amountMicros geändert

Der Name des Währungsfelds wurde von currency in currencyCode geändert. Das Format bleibt ISO 4217.