Regionsverwaltung migrieren

In dieser Anleitung wird beschrieben, wie Sie Ihre Integration von RegionsService in der Content API for Shopping zu RegionsService in der Unter-API „Accounts“ migrieren.

Mit dem Dienst „Regionen“ können Sie benutzerdefinierte geografische Gebiete für Anwendungsfälle wie regionale Preis- und Versandüberschreibungen definieren. Sie können Regionen mit Diensten wie RegionalInventory und ShippingSettings verwenden.

Wichtige Unterschiede

  • API-Struktur:Der Regions-Dienst ist jetzt Teil der Accounts-Unter-API in der Merchant API (z. B. merchantapi.googleapis.com/accounts/v1/...).
  • Ressourcennamen:In der Merchant API werden für die Vorgänge „Get“, „Update“ und „Delete“ Ressourcennamen (accounts/{account}/regions/{region}) anstelle separater merchant_id- und region_id-Parameter im URL-Pfad verwendet.
  • AIP-Konformität:Die Merchant API-Methoden folgen den Standardmustern des API Improvement Proposal (z. B. Verwendung von parent für „List/Create“, name für „Get/Delete“ und standardmäßige Verwendung von update_mask).
  • Wrapper-Typen:Felder, für die in der Content API bisher google.protobuf.StringValue oder google.protobuf.BoolValue verwendet wurde, nutzen in der Merchant API jetzt Standardfelder vom Typ optional.
  • Neue Funktionen:
    • Mit der Merchant API wird in der Ressource Region der Typ RadiusArea eingeführt, um Regionen basierend auf einem Radius um einen Punkt zu definieren (anfangs mit TRUST_TESTER-Sichtbarkeit).
    • Batch-Methoden – BatchCreateRegions, BatchUpdateRegions, BatchDeleteRegions – sind verfügbar.
  • Fehlerbehandlung:Fehlercodes und ‑meldungen liefern genaueres Feedback.

Anfragen

So ändern sich die Anfragemuster:

Posten Content API for Shopping Merchant API Beschreibung
Endpunkt https://shoppingcontent.googleapis.com https://merchantapi.googleapis.com Die Basisdomain ändert sich.
Pfad abrufen /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} In der Merchant API wird die accounts-Unter-API und die Ressource name verwendet.
Listenpfad /content/v2.1/{merchant_id}/regions /accounts/v1/{parent=accounts/*}/regions In der Merchant API wird parent verwendet, um das Konto anzugeben.
Pfad erstellen /content/v2.1/{merchant_id}/regions /accounts/v1/{parent=accounts/*}/regions Die Merchant API verwendet parent. region_id ist ein Feld im Anfragetext.
Aktualisierungspfad /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Der Ressourcenname in der Merchant API ist Teil des region-Objekts im Text.
Pfad löschen /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Verwendet die Ressource name.

IDs

Ändern Sie die Verwendung von Kennungen so:

Posten Content API for Shopping Merchant API Beschreibung
Konto merchant_id (integer) account (Ganzzahl, Teil des Strings name oder parent) Suchen Sie im Ressourcennamenstring nach der Konto-ID, z. B. accounts/{account}.
Region region_id (string) {region} (String, Teil des name-Strings) Suchen Sie im Ressourcennamenstring nach der Regions-ID, z. B. accounts/{account}/regions/{region}.
Ressourcenname Wird nicht ausschließlich für Anfragen verwendet. name: accounts/{account}/regions/{region} Standardkennzeichnung für Get-/Update-/Delete-Anfragen.
Name des Elternteils Wird nicht ausschließlich für Anfragen verwendet. parent: accounts/{account} Standardkennzeichnung für List-/Create-Anfragen.

Ressourcen

Die Ressourcenstruktur von Region wurde geringfügig geändert:

Posten Content API for Shopping Merchant API Beschreibung
Ressourcenkennzeichner region_id (String), merchant_id (Int64) name (String): accounts/{account}/regions/{region} In der Merchant API wird ein einzelnes name-Feld als Ressourcen-ID verwendet.
display_name google.protobuf.StringValue optional string Wrapper-Typ entfernt.
radius_area Nicht verfügbar (N/V) RadiusArea Mit diesem neuen Typ werden Regionen anhand des Radius definiert. Enthält region_code, lat_lng, radius, radius_units. Standardmäßig ist die Sichtbarkeit eingeschränkt.
regional_inventory_eligible google.protobuf.BoolValue (nur Ausgabe) optional bool (nur Ausgabe) Wrapper-Typ entfernt.
shipping_eligible google.protobuf.BoolValue (nur Ausgabe) optional bool (nur Ausgabe) Wrapper-Typ entfernt.

Methoden

Ändern Sie die Verwendung von Methoden so:

Posten Content API for Shopping Merchant API Beschreibung
Region abrufen GetRegion GetRegion Die Anfrage verwendet name.
Region erstellen CreateRegion CreateRegion Die Anfrage übernimmt parent aus der URL, während der Anfragetext das Objekt region und region_id enthält.
Region aktualisieren UpdateRegion UpdateRegion In der Anfrage werden region (das region.name enthalten muss) und update_mask verwendet.
Region löschen DeleteRegion DeleteRegion Die Anfrage verwendet name.
Regionen auflisten ListRegions ListRegions Die Anfrage verwendet parent. Das Verhalten von page_size und page_token ist konsistent.
Batch Create – BatchCreateRegions Das ist eine neue Methode.
Batch-Update – BatchUpdateRegions Das ist eine neue Methode.
Batch-Löschvorgang – BatchDeleteRegions Das ist eine neue Methode.

Umbenannte Felder

Posten Content API for Shopping Merchant API Beschreibung
Konto-ID merchant_id account (Teil von name oder parent) In name-Ressourcenstrings integriert. Dies betrifft Region (Antwort) und Protobuf-Nachrichten, die zum Senden von API-Anfragen verwendet werden, z. B. CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest und ListRegionsRequest.
Regions-ID region_id region (Teil von name), region_id Bei den meisten in name integriert, separates region_id-Feld in CreateRegionRequest. Dies betrifft Region (Antwort) und Protobuf-Nachrichten, die zum Senden von API-Anfragen verwendet werden, z. B. CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest und ListRegionsRequest.
Name der Region (Ausgabe) region_id name Das primäre Identifikatorfeld in der Antwort ist jetzt die vollständige Ressource name. Das betrifft Region.
Anzeigename display_name display_name Der Typ ändert sich von StringValue in optional string. Das betrifft Region.
Flags zur Teilnahmeberechtigung ...eligible ...eligible Der Typ ändert sich von BoolValue in optional bool. Das betrifft Region.
Aktualisierungsmaske update_mask update_mask Region-Feldpfade. Das betrifft UpdateRegionRequest.

Weitere Informationen

Zurück
Migrate homepage management
Weiter
Migrate inventory management