Method: customers.searchAds360.searchStream

Arama akışı sorgusuyla eşleşen tüm satırları döndürür.

Atılan hataların listesi: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

HTTP isteği

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
customerId

string

Zorunlu. Sorgulanan müşterinin kimliği.

İstek içeriği

İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi
{
  "query": string,
  "batchSize": integer,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Alanlar
query

string

Zorunlu. Sorgu dizesi.

batchSize

integer

Her bir akış yanıt grubunda döndürülen satır sayısı. Çok büyük gruplar için istekte bulunulduğunda, sunucu döndürülen satır sayısını daha da sınırlandırmaya karar verebilir.

summaryRowSetting

enum (SummaryRowSetting)

Bir özet satırının döndürülüp döndürülmeyeceğini belirler. Varsayılan olarak, özet satırı döndürülmez. İstenirse diğer tüm sorgu sonuçları döndürüldükten sonra özet satırı tek başına yanıt olarak gönderilir.

Yanıt gövdesi

SearchAds360Service.SearchStream için yanıt mesajı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "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
}
Alanlar
results[]

object (SearchAds360Row)

Sorguyla eşleşen satırların listesi.

fieldMask

string (FieldMask format)

Kullanıcının hangi alanları istediğini temsil eden FieldMask.

Bu, tam nitelikli alan adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo".

summaryRow

object (SearchAds360Row)

Sonuçlardaki metriklerin özetini içeren özet satırı. Metriklerin özeti, tüm sonuçlardaki metriklerin toplanması anlamına gelir. Burada toplama, toplam, ortalama, oran vb. olabilir.

customColumnHeaders[]

object (CustomColumnHeader)

Sonuçlardaki özel sütunların başlıkları.

conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

Sonuçlardaki dönüşüm özel metriklerinin başlıkları.

conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

Sonuçlardaki dönüşüm özel boyutunun başlıkları.

rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

Sonuçlardaki ham etkinlik dönüşüm metriklerinin başlıkları.

rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Sonuçlardaki ham etkinlik dönüşüm boyutlarının başlıklarıdır.

requestId

string

Hata ayıklama amacıyla kullanılan isteğin benzersiz kimliği.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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