Tổng quan

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 của họ bằng cách lập trình thông qua Ngôn ngữ truy vấn Merchant Center. Điều này tương tự như khả năng 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 cho 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ổng 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 lệnh gọi Tìm kiếm, chẳng hạn như:

  • Chỉ số cần 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)
  • Các điều kiện cần đá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 như các 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 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 các giá trị của 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, hệ thống sẽ trả về một hàng duy nhất với các chỉ số được tổng hợp trên tất cả phân khúc. Nếu không, nếu có phân khúc 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 mỗi bộ dữ liệu phân khúc duy nhất. Bạn có thể chọn nhiều phân khúc 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 được trả về. Bạn phải thêm bộ lọc theo 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 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ã JSON mẫu bên dưới cho biết người bán này đã có tổng cộng 4.440 lượt nhấp trên tất cả sản phẩm của họ trên tất cả các đích đế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 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. Phân khúc 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 một sự kiện được báo cáo (date, program). Sự kiện được báo cáo là một lượt hiển thị hoặc lượt nhấp vào một sản phẩm.

Các phân đoạn hoạt động tương tự như 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 về phạm vi ngày. Hệ thống sẽ 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 mã JSON mẫu bên dưới cho biết người bán này đã có 1.546 lượt nhấp vào tất cả sản phẩm trên tất cả các đích đế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ả các đích đến vào ngày 2 tháng 12 năm 2020. Sẽ 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"
      }
    }
]}
Tiếp
Ngữ pháp truy vấn