Method: accounts.reports.search

Truy xuất báo cáo được xác định bằng một cụm từ tìm kiếm. Phản hồi có thể chứa ít hàng hơn so với số lượng hàng do pageSize chỉ định. Dựa vào nextPageToken để xác định xem có thêm hàng nào cần yêu cầu hay không.

Yêu cầu HTTP

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
parent

string

Bắt buộc. Mã của tài khoản thực hiện lệnh gọi. Phải là tài khoản độc lập hoặc tài khoản phụ trong MCA. Định dạng: accounts/{account}

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
Trường
query

string

Bắt buộc. Truy vấn xác định báo cáo cần truy xuất.

Để biết thông tin chi tiết về cách tạo truy vấn, hãy xem hướng dẫn về Ngôn ngữ truy vấn. Để xem danh sách đầy đủ các bảng và trường có sẵn, hãy xem phần Trường có sẵn.
pageSize

integer

Không bắt buộc. Số ReportRows cần truy xuất trong một trang. Giá trị mặc định là 1000. Các giá trị trên 5000 sẽ được ép thành 5000.
pageToken

string

Không bắt buộc. Mã thông báo của trang cần truy xuất. Nếu không được chỉ định, hệ thống sẽ trả về trang kết quả đầu tiên. Để yêu cầu trang kết quả tiếp theo, bạn nên sử dụng giá trị thu được từ nextPageToken trong phản hồi trước đó.

Nội dung phản hồi

Thông báo phản hồi cho phương thức ReportService.Search.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
Trường
results[]

object (ReportRow)

Các hàng khớp với cụm từ tìm kiếm.
nextPageToken

string

Mã thông báo có thể được gửi dưới dạng pageToken để truy xuất trang tiếp theo. Nếu bạn bỏ qua, sẽ không có trang tiếp theo.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/content

Để biết thêm thông tin, hãy xem bài viết Tổng quan về OAuth 2.0.