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 „Regions“ 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 Ressourcennamen (accounts/{account}/regions/{region}) anstelle separater merchant_id- und region_id-Parameter im URL-Pfad für die Vorgänge „Get“, „Update“ und „Delete“ 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 zuvor google.protobuf.StringValue oder google.protobuf.BoolValue verwendet wurde, verwenden in der Merchant API jetzt Standardfelder vom Typ optional.
  • Neue Funktionen:
    • In 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).
    • Es sind Batch-Methoden verfügbar: BatchCreateRegions, BatchUpdateRegions, BatchDeleteRegions.
  • Fehlerbehandlung:Fehlercodes und ‑meldungen liefern spezifischeres 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 Unter-API accounts und die Ressource name verwendet.
List Path /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 nach der Konto-ID, die in den Ressourcenname-String eingebettet ist, z. B. accounts/{account}.
Region region_id (string) {region} (String, Teil des name-Strings) Suchen Sie im String des Ressourcennamens 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 übergeordneten Elements Wird nicht ausschließlich für Anfragen verwendet. parent: accounts/{account} Standardkennzeichnung für List-/Create-Anfragen.

Ressourcen

Die Ressourcenstruktur 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 Ettiketiereinheit entfernt.
radius_area Nicht verfügbar (N/V) RadiusArea Bei diesem neuen Typ werden Regionen durch einen 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) Ettiketiereinheit entfernt.
shipping_eligible google.protobuf.BoolValue (nur Ausgabe) optional bool (nur Ausgabe) Ettiketiereinheit entfernt.

Methoden

Ändern Sie die Verwendung von Methoden so:

Posten Content API for Shopping Merchant API Beschreibung
Region abrufen GetRegion GetRegion In der Anfrage wird name verwendet.
Region erstellen CreateRegion CreateRegion Die Anfrage übernimmt den parent aus der URL, während der Anfragetext das region-Objekt und den 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 In der Anfrage wird name verwendet.
Regionen auflisten ListRegions ListRegions In der Anfrage wird parent verwendet. Das Verhalten von page_size und page_token ist konsistent.
Batch erstellen – 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 die Strings der Ressource name eingebunden. 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 In name integriert (für die meisten), separates Feld region_id 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 zu optional string. Das betrifft Region.
Flags zur Teilnahmeberechtigung ...eligible ...eligible Der Typ ändert sich von BoolValue zu optional bool. Das betrifft Region.
Maske aktualisieren update_mask update_mask Region Feldpfade. Das betrifft UpdateRegionRequest.

Weitere Informationen

Zurück
Migrate homepage management
Weiter
Migrate shipping settings management