Method: customers.googleAds.searchStream

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

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

HTTP isteği

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds: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 metni aşağıdaki yapıyla birlikte verileri içerir:

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

string

Zorunlu. Sorgu dizesi.
summaryRowSetting

enum (SummaryRowSetting)

Ö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 özet satırı, diğer tüm sorgu sonuçları döndürüldükten sonra tek başına bir yanıt olarak gönderilir.

Yanıt gövdesi

GoogleAdsService.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 (GoogleAdsRow)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
Alanlar
results[]

object (GoogleAdsRow)

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

string (FieldMask format)

Kullanıcı tarafından hangi alanların istendiğini temsil eden FieldMask.

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

object (GoogleAdsRow)

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

string

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

string (int64 format)

Sorguyu yayınlamak için tüketilen kaynak miktarı. Özet satırı ve özet olmayan yanıtlar için queryResourceConsumption, ilgili satırlarda ayrı olarak döndürülür. Özet olmayan yanıtlar için queryResourceConsumption, nihai sonuç grubu içinde döndürülür.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için OAuth 2.0 Overview sayfasına bakın.

SummaryRowSetting

İade özeti satır ayarlarını açıklayan bir enum.

Sıralamalar
UNSPECIFIED Belirtilmedi.
UNKNOWN İade özeti satırının bilinmeyen değerlerini temsil eder.
NO_SUMMARY_ROW Özet satırını döndürmeyin.
SUMMARY_ROW_WITH_RESULTS Sonuçlarla birlikte özet satırını döndürme. Özet satırı yalnızca son grupta döndürülür (son grupta sonuç olmaz).
SUMMARY_ROW_ONLY Yalnızca özet satırını döndürme ve sonuç döndürmeme.