Method: accounts.reports.search

Mengambil laporan yang ditentukan oleh kueri penelusuran. Respons mungkin berisi lebih sedikit baris daripada yang ditentukan oleh pageSize. Mengandalkan nextPageToken untuk menentukan apakah ada lebih banyak baris yang akan diminta.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. ID akun yang melakukan panggilan. Harus berupa akun mandiri atau sub-akun MCA. Format: accounts/{account}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "query": string,
  "pageSize": integer,
  "pageToken": string
}
Kolom
query

string

Wajib. Kueri yang menentukan laporan yang akan diambil.

Untuk mengetahui detail tentang cara membuat kueri, lihat panduan Bahasa Kueri. Untuk mengetahui daftar lengkap tabel dan kolom yang tersedia, lihat Kolom yang tersedia.
pageSize

integer

Opsional. Jumlah ReportRows yang akan diambil dalam satu halaman. Setelan defaultnya adalah 1.000. Nilai di atas 5.000 akan dikonversi menjadi 5.000.
pageToken

string

Opsional. Token halaman yang akan diambil. Jika tidak ditentukan, halaman pertama hasil akan ditampilkan. Untuk meminta halaman hasil berikutnya, nilai yang diperoleh dari nextPageToken dalam respons sebelumnya harus digunakan.

Isi respons

Pesan respons untuk metode ReportService.Search.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "results": [
    {
      object (ReportRow)
    }
  ],
  "nextPageToken": string
}
Kolom
results[]

object (ReportRow)

Baris yang cocok dengan kueri penelusuran.
nextPageToken

string

Token yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika dihilangkan, tidak ada halaman berikutnya.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.