Method: customers.searchAds360.searchStream

Menampilkan semua baris yang cocok dengan kueri aliran data penelusuran.

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

Permintaan HTTP

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360: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,
  "batchSize": integer,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Kolom
query

string

Wajib. String kueri.
batchSize

integer

Jumlah baris yang ditampilkan di setiap batch respons streaming. Jika permintaan batch yang terlalu besar, server dapat memutuskan untuk membatasi lebih lanjut jumlah baris yang ditampilkan.
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 SearchAds360Service.SearchStream.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
Kolom
results[]

object (SearchAds360Row)

Daftar baris yang cocok dengan kueri.
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 (SearchAds360Row)

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.
customColumnHeaders[]

object (CustomColumnHeader)

Header kolom kustom di hasil.
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

Header metrik kustom konversi dalam hasil.
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

Header dimensi kustom konversi dalam hasil.
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

Header metrik konversi peristiwa mentah dalam hasil.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Header dimensi konversi peristiwa mentah dalam hasil.
requestId

string

ID unik permintaan yang digunakan untuk tujuan proses debug.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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