Memigrasikan pengelolaan wilayah

Panduan ini menjelaskan cara memigrasikan integrasi dari RegionsService di Content API for Shopping ke RegionsService dalam sub-API Akun.

Layanan Wilayah memungkinkan Anda menentukan area geografis kustom untuk kasus penggunaan seperti harga regional dan penggantian pengiriman. Anda dapat menggunakan wilayah dengan layanan seperti RegionalInventory dan ShippingSettings.

Perbedaan utama

  • Struktur API: Layanan Wilayah kini menjadi bagian dari sub-API Accounts di Merchant API (misalnya, merchantapi.googleapis.com/accounts/v1/...).
  • Nama resource: Merchant API menggunakan nama resource (accounts/{account}/regions/{region}) dan bukan parameter merchant_id dan region_id terpisah di jalur URL untuk operasi Get, Update, dan Delete.
  • Kepatuhan AIP: Metode Merchant API mengikuti pola Proposal Peningkatan API standar (seperti menggunakan parent untuk List/Create, name untuk Get/Delete, dan penggunaan update_mask standar).
  • Jenis wrapper: Kolom yang sebelumnya menggunakan google.protobuf.StringValue atau google.protobuf.BoolValue di Content API kini menggunakan kolom optional standar di Merchant API.
  • Fitur baru:
    • Merchant API memperkenalkan jenis RadiusArea dalam resource Region untuk menentukan wilayah berdasarkan radius di sekitar titik (awalnya dengan visibilitas TRUST_TESTER).
    • Metode batch - BatchCreateRegions, BatchUpdateRegions, BatchDeleteRegions - tersedia.
  • Penanganan error: Kode dan pesan error memberikan masukan yang lebih spesifik.

Permintaan

Berikut cara pola permintaan berubah:

Item Content API for Shopping Merchant API Deskripsi
Endpoint https://shoppingcontent.googleapis.com https://merchantapi.googleapis.com Domain dasar berubah.
Jalur Get /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Merchant API menggunakan sub-API accounts dan name resource.
Jalur Daftar /content/v2.1/{merchant_id}/regions /accounts/v1/{parent=accounts/*}/regions Merchant API menggunakan parent untuk menentukan akun.
Jalur Buat /content/v2.1/{merchant_id}/regions /accounts/v1/{parent=accounts/*}/regions Merchant API menggunakan parent. region_id adalah kolom di isi permintaan.
Jalur Update /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Nama resource di Merchant API adalah bagian dari objek region di isi.
Jalur Hapus /content/v2.1/{merchant_id}/regions/{region_id} /accounts/v1/{name=accounts/*/regions/*} Menggunakan name resource.

ID

Ubah penggunaan ID Anda sebagai berikut:

Item Content API for Shopping Merchant API Deskripsi
Akun merchant_id (bilangan bulat) account (bilangan bulat, bagian dari string name atau parent) Temukan ID akun yang disematkan dalam string nama resource, misalnya, accounts/{account}.
Region region_id (string) {region} (string, bagian dari string name) Temukan ID wilayah yang disematkan dalam string nama resource, misalnya, accounts/{account}/regions/{region}.
Nama Resource Tidak digunakan secara ketat untuk permintaan. name: accounts/{account}/regions/{region} ID standar untuk permintaan Get/Update/Delete.
Nama Parent Tidak digunakan secara ketat untuk permintaan. parent: accounts/{account} ID standar untuk permintaan List/Create.

Resource

Struktur resource Region memiliki perubahan kecil:

Item Content API for Shopping Merchant API Deskripsi
ID Resource region_id (string), merchant_id (int64) name (string): accounts/{account}/regions/{region} Merchant API menggunakan satu kolom name sebagai ID resource.
display_name google.protobuf.StringValue optional string Jenis wrapper dihapus.
radius_area Tidak Tersedia (T/A) RadiusArea Jenis baru ini menentukan wilayah berdasarkan radius. Mencakup region_code, lat_lng, radius, radius_units. Secara default, visibilitas dibatasi.
regional_inventory_eligible google.protobuf.BoolValue (hanya output) optional bool (hanya output) Jenis wrapper dihapus.
shipping_eligible google.protobuf.BoolValue (hanya output) optional bool (hanya output) Jenis wrapper dihapus.

Metode

Ubah penggunaan metode Anda sebagai berikut:

Item Content API for Shopping Merchant API Deskripsi
Dapatkan Wilayah GetRegion GetRegion Permintaan menggunakan name.
Buat Wilayah CreateRegion CreateRegion Permintaan mengambil parent dari URL, sedangkan isi permintaan menyertakan objek region dan region_id.
Perbarui Wilayah UpdateRegion UpdateRegion Permintaan menggunakan region (yang harus menyertakan region.name) dan update_mask.
Hapus Wilayah DeleteRegion DeleteRegion Permintaan menggunakan name.
Daftar Wilayah ListRegions ListRegions Permintaan menggunakan parent. page_size dan page_token perilaku konsisten.
Buat Batch T/A BatchCreateRegions Ini adalah metode baru.
Perbarui Batch T/A BatchUpdateRegions Ini adalah metode baru.
Hapus Batch T/A BatchDeleteRegions Ini adalah metode baru.

Kolom yang diganti namanya

Item Content API for Shopping Merchant API Deskripsi
ID Akun merchant_id account (bagian dari name atau parent) Terintegrasi ke dalam string name resource. Hal ini memengaruhi Region (respons) dan pesan protobuf yang digunakan untuk membuat permintaan API seperti CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest dan ListRegionsRequest.
ID Wilayah region_id region (bagian dari name), region_id Terintegrasi ke dalam name untuk sebagian besar, kolom region_id terpisah di CreateRegionRequest. Hal ini memengaruhi Region (respons) dan pesan protobuf yang digunakan untuk membuat permintaan API, seperti CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest dan ListRegionsRequest.
Nama Wilayah (Output) region_id name Kolom ID utama dalam respons kini adalah name resource lengkap. Hal ini memengaruhi Region.
Nama Tampilan display_name display_name Jenisnya berubah dari StringValue menjadi optional string. Hal ini memengaruhi Region.
Flag kelayakan ...eligible ...eligible Jenisnya berubah dari BoolValue menjadi optional bool. Hal ini memengaruhi Region.
Mask Update update_mask update_mask Jalur kolom Region. Hal ini memengaruhi UpdateRegionRequest.

Pelajari lebih lanjut

Sebelumnya
Migrate homepage management
Berikutnya
Migrate inventory management