Khả năng tương thích của Content API for Shopping

Bạn có thể làm theo hướng dẫn này để tích hợp API Merchant Center với phương thức triển khai Content API for Shopping hiện tại.

Bắt đầu

Xem phần thiết kế API Người bán để biết thông tin chi tiết về API Người bán và API phụ của API đó.

Để bắt đầu sử dụng API Merchant, hãy thay đổi URL yêu cầu của bạn thành định dạng sau:

https://merchantapi.googleapis.com/{sub-API}/{version}/{resource name}/{service}:{method}…

Hãy xem hướng dẫn bắt đầu nhanh và tài liệu tham khảo về API Merchant Center để biết thêm thông tin.

Hỗ trợ gRPC

Merchant API hỗ trợ gRPC và REST. Bạn có thể sử dụng cùng lúc gRPC cho API Merchant và REST cho Content API for Shopping.

Thư viện ứng dụng của API Merchant yêu cầu phải có gRPC.

Hãy xem bài viết sử dụng gRPC để biết thêm thông tin.

Khả năng tương thích

Hướng dẫn này mô tả những thay đổi chung áp dụng cho toàn bộ API Merchant. Hãy xem những hướng dẫn sau đây để biết những thay đổi đối với một số tính năng:

• Di chuyển hoạt động quản lý tài khoản
• Di chuyển chế độ cài đặt thông tin vận chuyển
• Quản lý quá trình di chuyển sản phẩm
• Di chuyển hoạt động quản lý nguồn dữ liệu
• Quản lý di chuyển kho hàng
• Di chuyển hoạt động quản lý chương trình khuyến mãi
• Di chuyển quy trình quản lý báo cáo
• Di chuyển hoạt động quản lý nguồn chuyển đổi
• Di chuyển hoạt động quản lý đối tác nguồn cấp dữ liệu địa phương

Merchant API được thiết kế để hoạt động cùng với các tính năng hiện có của Content API for Shopping phiên bản 2.1.

Ví dụ: bạn có thể sử dụng Merchant Inventories API cùng với các khoảng không quảng cáo Content API for Shopping phiên bản 2.1 hiện có và triển khai products. Bạn có thể sử dụng Content API for Shopping để tải một sản phẩm tại cửa hàng địa phương mới lên (sản phẩm mà bạn bán tại cửa hàng địa phương), sau đó sử dụng tài nguyên Merchant Inventories API LocalInventory để quản lý thông tin tại cửa hàng của sản phẩm đó.

Lưu ý: Chúng tôi không thể đảm bảo khả năng tương thích ngược hoàn toàn cho các tính năng tương tự giữa Content API for Shopping và API Merchant do thiết kế cải tiến. Ví dụ: tên trường hoặc khả năng sử dụng của phương thức có thể khác nhau đối với cùng một tài nguyên trong Content API for Shopping và Merchant API.

Yêu cầu theo lô

Merchant API không hỗ trợ phương thức customBatch có trong Content API for Shopping. Thay vào đó, hãy xem phần Gửi yêu cầu hàng loạt. Nếu bạn sử dụng customBatch và cần tính năng này cho API Merchant, hãy cho chúng tôi biết lý do trong ý kiến phản hồi của bạn.

Giá trị nhận dạng

Để phù hợp với các nguyên tắc cải thiện API của Google, chúng tôi đã thực hiện một số thay đổi đối với giá trị nhận dạng cho tài nguyên API Merchant.

tên thay thế Id

Mọi tài nguyên API Merchant Center đều sử dụng trường name làm giá trị nhận dạng riêng biệt.

Dưới đây là ví dụ về cách sử dụng trường name trong lệnh gọi:

POST https://merchantapi.googleapis.com/inventories/v1beta/{parent}/regionalInventories:insert

Trường name mới này được trả về dưới dạng giá trị nhận dạng tài nguyên cho tất cả các lệnh gọi đọc và ghi trong API Merchant.

Giá trị được trả về trong các trường name sử dụng định dạng mã nhận dạng mới.

Lưu ý quan trọng: Bạn nên sử dụng giá trị từ trường name ngay trong các lệnh gọi, thay vì phân tích cú pháp hoặc tạo tên tài nguyên theo cách thủ công để tránh gặp vấn đề.

Ví dụ: triển khai phương thức getName() để truy xuất name từ một tài nguyên và lưu trữ kết quả dưới dạng biến thay vì tự tạo name từ mã người bán và mã tài nguyên.

Định dạng mã nhận dạng mới

Lưu ý: API Merchant sẽ trả về các mã nhận dạng không có giá trị channel cho đến hết ngày 13 tháng 11 năm 2023. Sau ngày 13 tháng 11, tất cả cuộc gọi sẽ trả về mã tài nguyên đầy đủ. Bạn phải sử dụng mã tài nguyên đầy đủ (bao gồm cả channel) trong các lệnh gọi chậm nhất vào ngày 1 tháng 2 năm 2024.

Trong API Merchant, mã nhận dạng tài nguyên sẽ ở định dạng sau: channel~language~feedLabel~offerId

Tài nguyên Content API đã sử dụng : thay vì ~ giữa mỗi giá trị trong mã nhận dạng: channel:language:feedLabel:offerId

Tất cả lệnh gọi API Merchant Center đều trả về định dạng mới với ~ giữa các giá trị của mã nhận dạng. Bạn nên lưu trữ định dạng mới khỏi phản hồi và sử dụng định dạng đó trong các lệnh gọi sau này.

trường mẹ cho các tài nguyên con

Trong API Merchant, mọi tài nguyên con đều có trường parent. Bạn có thể sử dụng trường parent để chỉ định name của tài nguyên cần chèn phần tử con vào, thay vì truyền toàn bộ tài nguyên mẹ. Bạn cũng có thể sử dụng trường parent với các phương thức list để liệt kê các tài nguyên con của parent đó.

Ví dụ: để liệt kê kho hàng tại địa phương cho một sản phẩm nhất định, hãy chỉ định name của sản phẩm đó trong trường parent cho phương thức list. Trong trường hợp này, product đã cho là parent của tài nguyên LocalInventory được trả về.

Loại

Dưới đây là một số loại dữ liệu phổ biến được chia sẻ giữa các API phụ của Merchant API.

Giá

Dưới đây là những thay đổi đối với Price trong gói Merchant Common:

	Content API	API người bán
trường Số tiền	value:string	amountMicros:int64
Trường đơn vị tiền tệ	currency:string	currencyCode:string

Số tiền Price hiện được ghi lại dưới dạng phần triệu, trong đó 1 triệu phần triệu tương đương với đơn vị tiêu chuẩn của đơn vị tiền tệ của bạn.

Trong Content API for Shopping, Price là một số thập phân ở dạng chuỗi.

Tên trường số tiền đã thay đổi từ value thành amountMicros

Tên trường đơn vị tiền tệ đã thay đổi từ currency thành currencyCode. Định dạng vẫn là ISO 4217.