Di chuyển tính năng quản lý khu vực

Hướng dẫn này giải thích cách di chuyển quy trình tích hợp của bạn từ RegionsService trong Content API for Shopping sang RegionsService trong API phụ Accounts.

Dịch vụ Khu vực cho phép bạn xác định các khu vực địa lý tuỳ chỉnh cho các trường hợp sử dụng như giá theo khu vực và ghi đè phí vận chuyển. Bạn có thể sử dụng khu vực với các dịch vụ như RegionalInventory và ShippingSettings.

Những điểm khác biệt chính

• Cấu trúc API: Dịch vụ Regions hiện là một phần của API phụ Accounts trong Merchant API (ví dụ: merchantapi.googleapis.com/accounts/v1/...).
• Tên tài nguyên: Merchant API sử dụng tên tài nguyên (accounts/{account}/regions/{region}) thay vì các tham số merchant_id và region_id riêng biệt trong đường dẫn URL cho các thao tác Get, Update và Delete.
• Tuân thủ AIP: Các phương thức Merchant API tuân theo các mẫu Đề xuất cải tiến API tiêu chuẩn (chẳng hạn như sử dụng parent cho List/Create, name cho Get/Delete và cách sử dụng update_mask tiêu chuẩn).
• Kiểu trình bao bọc: Các trường trước đây sử dụng google.protobuf.StringValue hoặc google.protobuf.BoolValue trong Content API hiện sử dụng các trường optional chuẩn trong Merchant API.
• Tính năng mới:
  • Merchant API giới thiệu loại RadiusArea trong tài nguyên Region để xác định các khu vực dựa trên bán kính xung quanh một điểm (ban đầu có chế độ hiển thị TRUST_TESTER).
  • Bạn có thể sử dụng các phương thức theo lô – BatchCreateRegions, BatchUpdateRegions, BatchDeleteRegions.
• Xử lý lỗi: Mã lỗi và thông báo lỗi cung cấp thông tin phản hồi cụ thể hơn.

Yêu cầu

Sau đây là cách thay đổi mẫu yêu cầu:

Item	Content API for Shopping	Merchant API	Nội dung mô tả
Điểm cuối	https://shoppingcontent.googleapis.com	https://merchantapi.googleapis.com	Miền cơ sở thay đổi.
Lấy đường dẫn	/content/v2.1/{merchant_id}/regions/{region_id}	/accounts/v1/{name=accounts/*/regions/*}	Merchant API sử dụng API phụ accounts và tài nguyên name.
Đường dẫn danh sách	/content/v2.1/{merchant_id}/regions	/accounts/v1/{parent=accounts/*}/regions	Merchant API sử dụng parent để chỉ định tài khoản.
Tạo đường dẫn	/content/v2.1/{merchant_id}/regions	/accounts/v1/{parent=accounts/*}/regions	Merchant API sử dụng parent. region_id là một trường trong nội dung yêu cầu.
Đường dẫn cập nhật	/content/v2.1/{merchant_id}/regions/{region_id}	/accounts/v1/{name=accounts/*/regions/*}	Tên tài nguyên trong Merchant API là một phần của đối tượng region trong nội dung.
Xoá đường dẫn	/content/v2.1/{merchant_id}/regions/{region_id}	/accounts/v1/{name=accounts/*/regions/*}	Sử dụng tài nguyên name.

Giá trị nhận dạng

Thay đổi cách sử dụng giá trị nhận dạng như sau:

Item	Content API for Shopping	Merchant API	Nội dung mô tả
Tài khoản	merchant_id (số nguyên)	account (số nguyên, một phần của chuỗi name hoặc parent)	Tìm mã tài khoản được nhúng trong chuỗi tên tài nguyên, ví dụ: accounts/{account}.
Khu vực	region_id (chuỗi)	{region} (chuỗi, một phần của chuỗi name)	Tìm mã khu vực được nhúng trong chuỗi tên tài nguyên, ví dụ: accounts/{account}/regions/{region}.
Tên tài nguyên	Không chỉ dùng cho các yêu cầu.	name: accounts/{account}/regions/{region}	Giá trị nhận dạng chuẩn cho các yêu cầu Lấy/Cập nhật/Xoá.
Tên cha mẹ	Không chỉ dùng cho các yêu cầu.	parent: accounts/{account}	Giá trị nhận dạng chuẩn cho các yêu cầu List/Create.

Tài nguyên

Cấu trúc tài nguyên Region có một số thay đổi nhỏ:

Item	Content API for Shopping	Merchant API	Nội dung mô tả
Giá trị nhận dạng tài nguyên	region_id (chuỗi), merchant_id (int64)	name (chuỗi): accounts/{account}/regions/{region}	Merchant API sử dụng một trường name duy nhất làm giá trị nhận dạng tài nguyên.
display_name	google.protobuf.StringValue	optional string	Đã xoá loại trình bao bọc.
radius_area	Không áp dụng (N/A)	RadiusArea	Loại mới này xác định khu vực theo bán kính. region_code, lat_lng, radius, radius_units. Theo mặc định, chế độ hiển thị bị hạn chế.
regional_inventory_eligible	google.protobuf.BoolValue (chỉ đầu ra)	optional bool (chỉ đầu ra)	Đã xoá loại trình bao bọc.
shipping_eligible	google.protobuf.BoolValue (chỉ đầu ra)	optional bool (chỉ đầu ra)	Đã xoá loại trình bao bọc.

Phương thức

Thay đổi cách sử dụng các phương thức như sau:

Item	Content API for Shopping	Merchant API	Nội dung mô tả
Lấy khu vực	GetRegion	GetRegion	Yêu cầu sử dụng name.
Tạo khu vực	CreateRegion	CreateRegion	Yêu cầu lấy parent từ URL, trong khi phần nội dung yêu cầu bao gồm đối tượng region và region_id.
Cập nhật khu vực	UpdateRegion	UpdateRegion	Yêu cầu này sử dụng region (phải bao gồm region.name) và update_mask.
Xoá khu vực	DeleteRegion	DeleteRegion	Yêu cầu sử dụng name.
Liệt kê khu vực	ListRegions	ListRegions	Yêu cầu sử dụng parent. Hành vi của page_size và page_token là nhất quán.
Tạo hàng loạt	Không áp dụng	BatchCreateRegions	Đây là một phương thức mới.
Cập nhật theo lô	Không áp dụng	BatchUpdateRegions	Đây là một phương thức mới.
Xoá hàng loạt	Không áp dụng	BatchDeleteRegions	Đây là một phương thức mới.

Trường được đổi tên

Item	Content API for Shopping	Merchant API	Nội dung mô tả
Mã tài khoản	merchant_id	account (một phần của name hoặc parent)	Được tích hợp vào chuỗi tài nguyên name. Điều này ảnh hưởng đến Region (phản hồi) và thông báo protobuf dùng để gửi yêu cầu API, chẳng hạn như CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest và ListRegionsRequest.
Mã khu vực	region_id	region (một phần của name), region_id	Được tích hợp vào name cho hầu hết, trường region_id riêng biệt trong CreateRegionRequest. Điều này ảnh hưởng đến Region (phản hồi) và thông báo protobuf dùng để gửi yêu cầu API, chẳng hạn như CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest và ListRegionsRequest.
Tên khu vực (Kết quả)	region_id	name	Trường giá trị nhận dạng chính trong phản hồi hiện là name tài nguyên đầy đủ. Điều này ảnh hưởng đến Region.
Tên hiển thị	display_name	display_name	Loại thay đổi từ StringValue thành optional string. Điều này ảnh hưởng đến Region.
Cờ đủ điều kiện	...eligible	...eligible	Loại thay đổi từ BoolValue thành optional bool. Điều này ảnh hưởng đến Region.
Mặt nạ cập nhật	update_mask	update_mask	Region đường dẫn trường. Điều này ảnh hưởng đến UpdateRegionRequest.

Tìm hiểu thêm

• Tài nguyên REST: accounts.regions cho Merchant API
• Hướng dẫn về khu vực
• Thiết lập khu vực