Method: customers.googleAds.search

Menampilkan semua baris yang cocok dengan kueri penelusuran.

Daftar error yang ditampilkan: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

Permintaan HTTP

POST https://googleads.googleapis.com/v16/customers/{customerId}/googleAds:search

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
customerId

string

Wajib. ID pelanggan yang dikueri.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "query": string,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Kolom
query

string

Wajib. String kueri.
pageToken

string

Token halaman yang akan diambil. Jika tidak ditentukan, halaman pertama hasil akan ditampilkan. Gunakan nilai yang diperoleh dari nextPageToken dalam respons sebelumnya untuk meminta halaman hasil berikutnya.
pageSize

integer

Jumlah elemen yang akan diambil dalam satu halaman. Jika halaman yang diminta terlalu besar, server dapat memutuskan untuk membatasi lebih lanjut jumlah resource yang ditampilkan.
validateOnly

boolean

Jika true (benar), permintaan divalidasi tetapi tidak dijalankan.
returnTotalResultsCount

boolean

Jika true (benar), jumlah total hasil yang cocok dengan kueri yang mengabaikan klausa LIMIT akan disertakan dalam respons. Defaultnya adalah false.
summaryRowSetting

enum (SummaryRowSetting)

Menentukan apakah baris ringkasan akan ditampilkan. Secara default, baris ringkasan tidak ditampilkan. Jika diminta, baris ringkasan akan dikirimkan sebagai respons setelah semua hasil kueri lainnya ditampilkan.

Isi respons

Pesan respons untuk GoogleAdsService.Search.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "queryResourceConsumption": string
}
Kolom
results[]

object (GoogleAdsRow)

Daftar baris yang cocok dengan kueri.
nextPageToken

string

Token penomoran halaman digunakan untuk mengambil halaman hasil berikutnya. Teruskan konten string ini sebagai atribut pageToken permintaan berikutnya. nextPageToken tidak ditampilkan untuk halaman terakhir.
totalResultsCount

string (int64 format)

Jumlah total hasil yang cocok dengan kueri yang mengabaikan klausa LIMIT.
fieldMask

string (FieldMask format)

FieldMask yang mewakili kolom yang diminta oleh pengguna.

Ini adalah daftar yang dipisahkan koma yang berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".
summaryRow

object (GoogleAdsRow)

Baris ringkasan yang berisi ringkasan metrik dalam hasil. Ringkasan metrik berarti agregasi metrik di semua hasil, di sini agregasi dapat berupa jumlah, rata-rata, kecepatan, dll.
queryResourceConsumption

string (int64 format)

Jumlah resource yang terpakai untuk menyajikan kueri.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.