API báo cáo

Reporting API cho phép người bán tương tác với dữ liệu hiệu suất của họ theo cách có lập trình thông qua Ngôn ngữ truy vấn Merchant Center. Tính năng này tương tự như khả năng tạo báo cáo tuỳ chỉnh ngay trong Merchant Center. Reporting API mang lại những lợi ích sau:

• Cho phép những người bán lớn nhập dữ liệu hiệu suất cho trang thông tin sản phẩm vào hệ thống báo cáo nội bộ hoặc hệ thống báo cáo 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 báo cáo.

Người dùng API có thể chỉ định dữ liệu hiệu suất mà họ muốn truy xuất trong phản hồi của lệnh gọi 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ị)
• Phương diện để phân đoạn dữ liệu (ví dụ: OfferId, Date)
• Điều kiện cần đáp ứng (ví dụ: Số lượt nhấp > 100)

Ngôn ngữ truy vấn Reporting API có thể truy vấn Content API for Shopping để lấy 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 (thuộc tính sự kiện được báo cáo như chương trình và ngày, cũng như thuộc tính sản phẩm như thương hiệu, danh mục, v.v.), bằng cách sử dụng phương thức Search trên dịch vụ Reports.

Kết quả của một truy vấn đến dịch vụ Reports là một danh sách các thực thể ReportRow, trong đó mỗi ReportRow đại diện cho các giá trị của những chỉ số được yêu cầu cho các phân khúc mà bạn đã chỉ định trong truy vấn. Nếu bạn không chỉ định phân khúc nào, thì một hàng duy nhất sẽ được trả về với các chỉ số được tổng hợp trên tất cả các phân khúc. Nếu không, nếu bạn yêu cầu bất kỳ phân đoạn nào cùng với các chỉ số, thì phản hồi sẽ cho thấy một hàng cho mỗi bộ phân đoạn duy nhất. Bạn có thể chọn nhiều phân đoạn và nhiều chỉ số trong một truy vấn duy nhất.

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ị, Tỷ lệ nhấp, v.v.) mà bạn muốn được trả về. Bạn phải thêm bộ lọc vào 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 được thêm của 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 mẫu về mã JSON bên dưới cho biết tổng số lượt nhấp mà người bán này đã nhận được là 4.440 lượt cho tất cả sản phẩm trên tất cả vị trí xuất hiện trong khoảng thời gian từ ngày 1 tháng 12 năm 2020 đến ngày 21 tháng 12 năm 2020.

{"results": [
    {
      "metrics": {
        "clicks": "4,440"
      }
    }
]}

Truy vấn cho phân đoạn

Bên cạnh các chỉ số, bạn cũng có thể truy vấn các phân đoạn. Phân đoạn có thể là một thuộc tính của sản phẩm (offer_id, brand, category, v.v.) hoặc một thuộc tính của 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 khúc hoạt động tương tự như một GROUP BY trong SQL. 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 đã thêm của một phạm vi ngày. Chỉ những hàng có ít nhất một chỉ số được yêu cầu khác 0 mới được trả về.

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 mã JSON mẫu bên dưới cho biết cách người bán này nhận được 1.546 lượt nhấp vào tất cả sản phẩm trên tất cả vị trí xuất hiện vào ngày 1 tháng 12 năm 2020 và 829 lượt nhấp vào tất cả sản phẩm trên tất cả vị trí xuất hiện vào ngày 2 tháng 12 năm 2020. Không có đối tượng nào được trả về cho ngày 3 tháng 12 năm 2020 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"
      }
    }
]}