Regionsverwaltung migrieren

In diesem Leitfaden wird erläutert, wie Sie Ihre Integration von RegionsService in der Content API for Shopping zu RegionsService in der Accounts-Sub-API migrieren.

Mit dem Regions-Dienst können Sie benutzerdefinierte geografische Gebiete für Anwendungsfälle wie regionale Preisgestaltung 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-Sub-API in der Merchant API (z. B. merchantapi.googleapis.com/accounts/v1/...).
  • Ressourcennamen:In der Merchant API werden Ressourcennamen (accounts/{account}/regions/{region}) anstelle separater Parameter merchant_id und region_id im URL-Pfad für Get-, Update- und Delete-Vorgänge verwendet.
  • AIP-Konformität: Die Methoden der Merchant API folgen den Standardmustern für API Improvement Proposals (z. B. Verwendung von parent für List/Create, name für Get/Delete und Standardnutzung von update_mask).
  • Wrapper-Typen:Für Felder, die zuvor google.protobuf.StringValue oder google.protobuf.BoolValue in der Content API verwendet haben, werden jetzt standardmäßige optional-Felder in der Merchant API verwendet.
  • Neue Funktionen:
    • In der Merchant API wird der Typ RadiusArea in der Ressource Region eingeführt, um Regionen basierend auf einem Radius um einen Punkt zu definieren (zunächst mit der Sichtbarkeit TRUST_TESTER).
    • 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 werden die Sub-API accounts und ein Ressourcenname name verwendet.
Pfad auflisten /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 In der Merchant API wird parent verwendet. region_id ist ein Feld im Anfragetext.
Pfad aktualisieren /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Der Ressourcenname in der Merchant API ist Teil des Objekts region im Text.
Pfad löschen /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Verwendet den Ressourcennamen name.

IDs

Ändern Sie die Verwendung von IDs wie folgt:

Posten Content API for Shopping Merchant API Beschreibung
Konto merchant_id (Ganzzahl) account (Ganzzahl, Teil des Strings name oder parent) Die Konto-ID ist im String des Ressourcennamens eingebettet, z. B. accounts/{account}.
Region region_id (String) {region} (String, Teil des Strings name) Die Regions-ID ist im String des Ressourcennamens eingebettet, z. B. accounts/{account}/regions/{region}.
Ressourcenname Wird nicht unbedingt für Anfragen verwendet. name: accounts/{account}/regions/{region} Standard-ID für Get-, Update- und Delete-Anfragen.
Übergeordneter Name Wird nicht unbedingt für Anfragen verwendet. parent: accounts/{account} Standard-ID für List-/Create-Anfragen.

Ressourcen

Die Struktur der Ressource Region wurde geringfügig geändert:

Posten Content API for Shopping Merchant API Beschreibung
Ressourcen-ID region_id (String), merchant_id (int64) name (String): accounts/{account}/regions/{region} In der Merchant API wird ein einzelnes Feld name als Ressourcen-ID verwendet.
display_name google.protobuf.StringValue optional string Wrapper-Typ entfernt.
radius_area Keine Angabe (–) RadiusArea Mit diesem neuen Typ werden Regionen nach 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 wie folgt:

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 enthält das Objekt region und das region_id.
Region aktualisieren UpdateRegion UpdateRegion Die Anfrage verwendet region (einschließlich region.name) und update_mask.
Region löschen DeleteRegion DeleteRegion Die Anfrage verwendet name.
Regionen auflisten ListRegions ListRegions Die Anfrage verwendet parent. page_size und page_token Verhalten ist konsistent.
Batch-Erstellung Keine Angabe (–) BatchCreateRegions Dies ist eine neue Methode.
Batch-Aktualisierung Keine Angabe (–) BatchUpdateRegions Dies ist eine neue Methode.
Batch-Löschung Keine Angabe (–) BatchDeleteRegions Dies 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 die Strings des Ressourcennamens name eingebettet. Dies wirkt sich auf Region (Antwort) und Protobuf-Nachrichten aus, die für API Anfragen verwendet werden, z. B. CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest und ListRegionsRequest.
Regions-ID region_id region (Teil von name), region_id Für die meisten in name eingebettet, separates region_id Feld in CreateRegionRequest. Dies wirkt sich auf Region (Antwort) und Protobuf-Nachrichten aus, die für API-Anfragen verwendet werden, z. B. CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest und ListRegionsRequest.
Regionsname (Ausgabe) region_id name Das primäre ID-Feld in der Antwort ist jetzt der vollständige Ressourcenname name. Dies wirkt sich auf Region aus.
Anzeigename display_name display_name Der Typ ändert sich von StringValue zu optional string. Dies wirkt sich auf Region aus.
Flags für die Berechtigung ...eligible ...eligible Der Typ ändert sich von BoolValue zu optional bool. Dies wirkt sich auf Region aus.
Aktualisierungsmaske update_mask update_mask Feldpfade für Region. Dies wirkt sich auf UpdateRegionRequest aus.

Weitere Informationen

Zurück
Migrate homepage management
Weiter
Migrate shipping settings management