Method: customers.googleAds.searchStream

Menampilkan semua baris yang cocok dengan kueri aliran penelusuran.

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

Permintaan HTTP

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

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,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Kolom
query

string

Wajib. String kueri.
summaryRowSetting

enum (SummaryRowSetting)

Menentukan apakah baris ringkasan akan ditampilkan. Secara default, baris ringkasan tidak ditampilkan. Jika diminta, baris ringkasan akan dikirim dalam respons secara otomatis setelah semua hasil kueri lainnya ditampilkan.

Isi respons

Pesan respons untuk GoogleAdsService.SearchStream.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

object (GoogleAdsRow)

Daftar baris yang cocok dengan kueri.
fieldMask

string (FieldMask format)

FieldMask yang mewakili kolom yang diminta oleh pengguna.

Ini adalah daftar dipisahkan koma yang berisi nama-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, rasio, dll.
requestId

string

ID unik permintaan yang digunakan untuk tujuan proses debug.
queryResourceConsumption

string (int64 format)

Jumlah resource yang digunakan untuk menayangkan kueri. queryResourceConsumption untuk baris Ringkasan dan respons non-Ringkasan ditampilkan secara terpisah di barisnya masing-masing. queryResourceConsumption untuk respons non-Ringkasan ditampilkan dalam batch hasil akhir.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

SummaryRowSetting

Enum yang menjelaskan setelan baris ringkasan pengembalian.

Enum
UNSPECIFIED Tidak ditentukan.
UNKNOWN Merepresentasikan nilai yang tidak diketahui dari baris ringkasan pengembalian.
NO_SUMMARY_ROW Jangan menampilkan baris ringkasan.
SUMMARY_ROW_WITH_RESULTS Menampilkan baris ringkasan beserta hasilnya. Baris ringkasan hanya akan ditampilkan dalam batch terakhir (batch terakhir tidak akan berisi hasil).
SUMMARY_ROW_ONLY Hanya menampilkan baris ringkasan dan tidak menampilkan hasil.