Memigrasikan pengelolaan wilayah

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

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

Perbedaan utama

• Struktur API: Layanan Regions 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}), bukan parameter merchant_id dan region_id terpisah di jalur URL untuk operasi Get, Update, dan Delete.
• Kepatuhan AIP: Metode Merchant API mengikuti pola API Improvement Proposal 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 perubahan pola permintaan:

Item	Content API for Shopping	Merchant API	Deskripsi
Endpoint	https://shoppingcontent.googleapis.com	https://merchantapi.googleapis.com	Domain dasar berubah.
Dapatkan Jalur	/content/v2.1/{merchant_id}/regions/{region_id}	/accounts/v1/{name=accounts/*/regions/*}	Merchant API menggunakan sub-API accounts dan resource name.
Jalur Daftar	/content/v2.1/{merchant_id}/regions	/accounts/v1/{parent=accounts/*}/regions	Merchant API menggunakan parent untuk menentukan akun.
Membuat Jalur	/content/v2.1/{merchant_id}/regions	/accounts/v1/{parent=accounts/*}/regions	Merchant API menggunakan parent. region_id adalah kolom dalam 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 dalam isi.
Menghapus Jalur	/content/v2.1/{merchant_id}/regions/{region_id}	/accounts/v1/{name=accounts/*/regions/*}	Menggunakan resource name.

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}.
Wilayah	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 Orang Tua	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. region_code, lat_lng, radius, radius_units. Secara default, visibilitas dibatasi.
regional_inventory_eligible	google.protobuf.BoolValue (khusus output)	optional bool (khusus output)	Jenis wrapper dihapus.
shipping_eligible	google.protobuf.BoolValue (khusus output)	optional bool (khusus output)	Jenis wrapper dihapus.

Metode

Ubah penggunaan metode Anda sebagai berikut:

Item	Content API for Shopping	Merchant API	Deskripsi
Mendapatkan Region	GetRegion	GetRegion	Permintaan menggunakan name.
Membuat Region	CreateRegion	CreateRegion	Permintaan mengambil parent dari URL, sedangkan isi permintaan menyertakan objek region dan region_id.
Memperbarui Region	UpdateRegion	UpdateRegion	Permintaan menggunakan region (yang harus menyertakan region.name) dan update_mask.
Menghapus Region	DeleteRegion	DeleteRegion	Permintaan menggunakan name.
Mencantumkan Region	ListRegions	ListRegions	Permintaan menggunakan parent. Perilaku page_size dan page_token konsisten.
Pembuatan Batch	T/A	BatchCreateRegions	Ini adalah metode baru.
Kumpulan Update	T/A	BatchUpdateRegions	Ini adalah metode baru.
Penghapusan 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 pesan Region (respons) dan 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. Tindakan ini akan memengaruhi Region.
Nama Tampilan	display_name	display_name	Jenisnya berubah dari StringValue menjadi optional string. Tindakan ini akan memengaruhi Region.
Flag kelayakan	...eligible	...eligible	Jenisnya berubah dari BoolValue menjadi optional bool. Tindakan ini akan memengaruhi Region.
Update Mask	update_mask	update_mask	Region jalur kolom. Hal ini memengaruhi UpdateRegionRequest.

Pelajari lebih lanjut

• Resource REST: accounts.regions untuk Merchant API
• Panduan region
• Menyiapkan wilayah