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 hoạt động tích hợp của bạn từ RegionsService trong Content API for Shopping sang RegionsService trong API phụ Tài khoản.

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à thông tin thay thế về phí vận chuyển. Bạn có thể sử dụng các khu vự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ụ Khu vực 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).
  • Các loại trình bao bọc: Các trường trước đây dùng google.protobuf.StringValue hoặc google.protobuf.BoolValue trong Content API hiện dùng các trường optional tiêu chuẩn trong Merchant API.
  • Các tính năng mới:
    • Merchant API giới thiệu một 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).
    • Các phương thức theo lô – BatchCreateRegions, BatchUpdateRegions, BatchDeleteRegions – hiện đã có.
  • 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 các mẫu yêu cầu thay đổi:

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.
Tải Path /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.
List Path /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.
Cập nhật đường dẫn /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 bạn 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 được dùng cho các yêu cầu. name: accounts/{account}/regions/{region} Giá trị nhận dạng tiêu chuẩn cho các yêu cầu Get/Update/Delete.
Tên cha mẹ Không được dùng cho các yêu cầu. parent: accounts/{account} Giá trị nhận dạng chuẩn cho 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 có (N/A) RadiusArea Loại mới này xác định các khu vực theo bán kính. Bao gồm 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ả
Get Region GetRegion GetRegion Yêu cầu này sử dụng name.
Tạo khu vực CreateRegion CreateRegion Yêu cầu lấy parent từ URL, trong khi 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 này sử dụng name.
List Regions (Liệt kê các khu vực) ListRegions ListRegions Yêu cầu này sử dụng parent. Hành vi của page_size và page_token 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 hàng loạt 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.

Các 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 các chuỗi name tài nguyên. Điều này ảnh hưởng đến Region (phản hồi) và các thông báo protobuf được dùng để đưa ra 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 các trường, trường region_id riêng biệt trong CreateRegionRequest. Điều này ảnh hưởng đến Region (phản hồi) và các thông báo protobuf dùng để đưa ra yêu cầu API, chẳng hạn như CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest và ListRegionsRequest.
Tên khu vực (Đầu ra) region_id name Trường giá trị nhận dạng chính trong phản hồi hiện là tài nguyên đầy đủ name. Việc 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. Việc này ảnh hưởng đến Region.
Cờ đủ điều kiện ...eligible ...eligible Loại thay đổi từ BoolValue thành optional bool. Việc này ảnh hưởng đến Region.
Cập nhật mặt nạ update_mask update_mask Region đường dẫn trường. Việc này ảnh hưởng đến UpdateRegionRequest.

Tìm hiểu thêm

Trước
Migrate homepage management
Tiếp
Migrate inventory management