Migracja zarządzania regionami

Z tego przewodnika dowiesz się, jak przeprowadzić migrację integracji z interfejsu RegionsService Content API for Shopping do interfejsu RegionsService w ramach podrzędnego interfejsu API Konta.

Usługa Regiony umożliwia definiowanie niestandardowych obszarów geograficznych na potrzeby takich przypadków użycia jak ceny regionalne i zastąpienia dostawy. Możesz korzystać z regionów z usługami, takimi jak RegionalInventory i ShippingSettings.

Najważniejsze różnice

  • Struktura interfejsu API: usługa Regions jest teraz częścią interfejsu API Accounts w Merchant API (np. merchantapi.googleapis.com/accounts/v1/...).
  • Nazwy zasobów: Merchant API używa nazw zasobów (accounts/{account}/regions/{region}) zamiast oddzielnych parametrów merchant_id i region_id w ścieżce adresu URL w przypadku operacji Get, Update i Delete.
  • Zgodność z AIP: metody Merchant API są zgodne ze standardowymi wzorcami API Improvement Proposal (np. używają parent w przypadku List/Create, name w przypadku Get/Delete i standardowego użycia update_mask).
  • Typy opakowań: pola, które wcześniej używały znaków google.protobuf.StringValue lub google.protobuf.BoolValue w Content API, teraz używają standardowych pól optional w Merchant API.
  • Nowe funkcje:
    • Merchant API wprowadza typ RadiusArea w zasobie Region do definiowania regionów na podstawie promienia wokół punktu (początkowo z widocznością TRUST_TESTER).
    • Dostępne są metody wsadowe – BatchCreateRegions, BatchUpdateRegions,BatchDeleteRegions.
  • Obsługa błędów: kody błędów i komunikaty o błędach zawierają bardziej szczegółowe informacje.

Żądania

Oto jak zmieniają się wzorce żądań:

Produkt Content API for Shopping Merchant API Opis
Punkt końcowy https://shoppingcontent.googleapis.com https://merchantapi.googleapis.com Domena podstawowa ulegnie zmianie.
Pobierz ścieżkę /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Merchant API korzysta z interfejsu accounts i zasobu name.
Ścieżka listy /content/v2.1/{merchant_id}/regions /accounts/v1/{parent=accounts/*}/regions Merchant API używa znaku parent do określania konta.
Utwórz ścieżkę /content/v2.1/{merchant_id}/regions /accounts/v1/{parent=accounts/*}/regions Merchant API korzysta z parent. region_id to pole w treści żądania.
Zaktualizuj ścieżkę /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Nazwa zasobu w interfejsie Merchant API jest częścią obiektu region w treści.
Usuń ścieżkę /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Używa zasobu name.

Identyfikatory

Zmień sposób używania identyfikatorów w ten sposób:

Produkt Content API for Shopping Merchant API Opis
Konto merchant_id (liczba całkowita) account (liczba całkowita, część ciągu znaków name lub parent) Znajdź identyfikator konta w ciągu nazwy zasobu, np. accounts/{account}.
Region region_id (ciąg znaków) {region} (ciąg znaków, część ciągu znaków name) Znajdź identyfikator regionu w ciągu nazwy zasobu, np. accounts/{account}/regions/{region}.
Nazwa zasobu Nie jest ściśle używane w przypadku żądań. name: accounts/{account}/regions/{region} Standardowy identyfikator żądań Get/Update/Delete.
Nazwa elementu nadrzędnego Nie jest ściśle używane w przypadku żądań. parent: accounts/{account} Standardowy identyfikator żądań List/Create.

Zasoby

Struktura zasobu Region została nieznacznie zmieniona:

Produkt Content API for Shopping Merchant API Opis
Identyfikator zasobu region_id (ciąg znaków), merchant_id (int64) name (ciąg znaków): accounts/{account}/regions/{region} Interfejs Merchant API używa pojedynczego pola name jako identyfikatora zasobu.
display_name google.protobuf.StringValue optional string Usunięto typ modułu owijającego.
radius_area Niedostępne RadiusArea Ten nowy typ definiuje regiony według promienia. Obejmuje:region_code, lat_lng, radius, radius_units. Domyślnie widoczność jest ograniczona.
regional_inventory_eligible google.protobuf.BoolValue (tylko dane wyjściowe) optional bool (tylko dane wyjściowe) Usunięto typ modułu owijającego.
shipping_eligible google.protobuf.BoolValue (tylko dane wyjściowe) optional bool (tylko dane wyjściowe) Usunięto typ modułu owijającego.

Metody

Zmień sposób używania metod w ten sposób:

Produkt Content API for Shopping Merchant API Opis
Pobierz region GetRegion GetRegion Żądanie używa metody name.
Utwórz region CreateRegion CreateRegion Żądanie pobiera parent z adresu URL, a treść żądania zawiera obiekt region i region_id.
Zaktualizuj region UpdateRegion UpdateRegion Żądanie używa parametrów region (który musi zawierać parametr region.name) i update_mask.
Usuń region DeleteRegion DeleteRegion Żądanie używa metody name.
List Regions ListRegions ListRegions Żądanie używa metody parent. page_size i page_token działają w spójny sposób.
Utwórz partię Nie dotyczy BatchCreateRegions To nowa metoda.
Aktualizacja zbiorcza Nie dotyczy BatchUpdateRegions To nowa metoda.
Usuwanie zbiorcze Nie dotyczy BatchDeleteRegions To nowa metoda.

Pola, których nazwy zostały zmienione

Produkt Content API for Shopping Merchant API Opis
Identyfikator konta merchant_id account (część name lub parent) Zintegrowane z ciągami znaków zasobu name. Dotyczy to Region (odpowiedzi) i komunikatów protokołu buforów danych używanych do wysyłania żądań do interfejsu API, takich jak CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest i ListRegionsRequest.
Identyfikator regionu region_id region (część name), region_id Większość usług jest zintegrowana z name, a w CreateRegionRequest jest dostępne oddzielne pole region_id. Dotyczy to Region (odpowiedzi) i komunikatów protobuf używanych do wysyłania żądań do interfejsu API, takich jak CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest i ListRegionsRequest.
Nazwa regionu (dane wyjściowe) region_id name Głównym polem identyfikatora w odpowiedzi jest teraz pełny zasób name. Będzie to miało wpływ na Region.
Wyświetlana nazwa display_name display_name Typ zmienia się z StringValue na optional string. Będzie to miało wpływ na Region.
Flagi kwalifikacji ...eligible ...eligible Typ zmienia się z BoolValue na optional bool. Dotyczy to Region.
Aktualizowanie maski update_mask update_mask Region ścieżki pól. Będzie to miało wpływ na UpdateRegionRequest.

Więcej informacji

Wstecz
Migrate homepage management
Dalej
Migrate shipping settings management