API báo cáo
API Báo cáo cho phép người bán tương tác với dữ liệu hiệu suất theo phương thức lập trình thông qua Ngôn ngữ truy vấn của Merchant Center. Điều này tương tự như việc tạo báo cáo tuỳ chỉnh ngay trong Merchant Center. API Báo cáo có các lợi ích sau:
- Cho phép người bán lớn nhập dữ liệu hiệu suất của trang thông tin sản phẩm vào hệ thống báo cáo nội bộ hoặc của bên thứ ba.
- Cho phép người dùng, đối tác bên thứ ba và đơn vị tập hợp quản lý tài khoản Merchant Center truy cập vào tính năng báo cáo.
Người dùng API có thể chỉ định dữ liệu hiệu suất họ muốn truy xuất trong phản hồi lệnh gọi của Tìm kiếm, chẳng hạn như:
- Các chỉ số sẽ được trả về (ví dụ: Số lượt nhấp, Số lượt hiển thị)
- Các phương diện để phân đoạn dữ liệu (ví dụ: Mã ưu đãi, Ngày)
- Các điều kiện cần được đáp ứng (ví dụ: Số lượt nhấp > 100)
Ngôn ngữ truy vấn API Báo cáo có thể truy vấn Content API for Shopping để biết các chỉ số hiệu suất (lượt nhấp, lượt hiển thị), có thể được phân đoạn theo nhiều phương diện (các thuộc tính sự kiện được báo cáo như chương trình và ngày, cùng các thuộc tính sản phẩm như thương hiệu, danh mục, v.v.) bằng phương thức Search trên dịch vụ Reports.
Kết quả từ truy vấn đến dịch vụ Reports là danh sách các thực thể ReportRow, trong đó mỗi ReportRow đại diện cho giá trị của các chỉ số được yêu cầu cho các phân đoạn mà bạn đã chỉ định trong truy vấn của mình. Nếu không có phân đoạn nào được chỉ định, thì hệ thống sẽ trả về một hàng duy nhất cùng với các chỉ số được tổng hợp trên tất cả các phân đoạn. Ngược lại, nếu bất kỳ phân đoạn nào được yêu cầu cùng với các chỉ số, thì phản hồi sẽ hiển thị một hàng cho từng bộ dữ liệu phân đoạn riêng biệt. Bạn có thể chọn nhiều phân đoạn và nhiều chỉ số trong một truy vấn.
Truy vấn chỉ số
Bạn có thể truy vấn các chỉ số (Số lượt nhấp, Số lượt hiển thị, CTR, v.v.) mà bạn muốn trả về. Bạn phải thêm một bộ lọc trong phạm vi ngày để truy vấn dịch vụ Báo cáo. Truy vấn mẫu bên dưới trả về một hàng duy nhất: tổng số lượt nhấp trong điều kiện đã thêm thuộc một phạm vi ngày.
SELECT metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-21';
Phản hồi mẫu
Phản hồi bằng mã JSON mẫu dưới đây cho thấy tổng cộng 4.440 lượt nhấp của người bán này trên tất cả các sản phẩm của họ ở tất cả các vị trí xuất hiện trong khoảng thời gian từ ngày 1/12/2020 đến ngày 21/12/2020.
{"results": [
{
"metrics": {
"clicks": "4,440"
}
}
]}
Truy vấn phân khúc
Bên cạnh các chỉ số, bạn cũng có thể truy vấn các phân khúc (có thể là thuộc tính của sản phẩm (offer_id, brand, category, v.v.) hoặc thuộc tính của một sự kiện được báo cáo (date, program). Sự kiện được báo cáo là lượt hiển thị hoặc lượt nhấp cho một sản phẩm.
Các phân đoạn hoạt động tương tự như GROUP BY trong SQL. Các phân đoạn chia các chỉ số đã chọn, nhóm theo từng phân đoạn trong mệnh đề SELECT. Truy vấn mẫu bên dưới trả về số lượt nhấp mỗi ngày, được sắp xếp theo số lượt nhấp giảm dần trong điều kiện được thêm vào của một phạm vi ngày. Hệ thống chỉ trả về các hàng có ít nhất một chỉ số được yêu cầu khác 0.
SELECT
segments.date,
metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-03'
ORDER BY metrics.clicks DESC;
Phản hồi mẫu
Phản hồi về mã JSON mẫu dưới đây cho thấy người bán này đã có 1.546 lượt nhấp trên tất cả sản phẩm ở tất cả các vị trí xuất hiện vào ngày 1/12/2020 và 829 lượt nhấp vào tất cả các sản phẩm tại tất cả các vị trí xuất hiện vào ngày 2/12/2020. Vào ngày 3 tháng 12 năm 2020, chúng tôi sẽ không trả lại đối tượng vì người bán không có lượt nhấp nào vào ngày đó.
{
"results": [
{
"segments": {
"date": {
"year": 2020,
"month": 12,
"day": 1
}
},
"metrics": {
"clicks": "1546"
}
},
{
"segments": {
"date": {
"year": 2020,
"month": 12,
"day": 2
}
},
"metrics": {
"clicks": "829"
}
}
]}