Method: customers.googleAds.search

Arama 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/v15/customers/{customerId}/googleAds:search

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ıyla birlikte veriler içerir:

JSON gösterimi
{
  "query": string,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Alanlar
query

string

Zorunlu. Sorgu dizesi.

pageToken

string

Alınacak sayfanın jetonu. Belirtilmezse sonuçların ilk sayfası döndürülür. Bir sonraki sonuç sayfasını istemek için önceki yanıtta nextPageToken değerinden elde edilen değeri kullanın.

pageSize

integer

Tek bir sayfada alınacak öğe sayısı. Çok büyük bir sayfa istendiğinde sunucu, döndürülen kaynakların sayısını daha da sınırlandırmaya karar verebilir.

validateOnly

boolean

Doğru değerine ayarlanırsa istek doğrulanır ancak yürütülmez.

returnTotalResultsCount

boolean

Doğru ise LIMIT yan tümcesi yok sayıldığında sorguyla eşleşen toplam sonuç sayısı yanıta dahil edilir. Varsayılan değer, false (yanlış) değeridir.

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

Yanıt gövdesi

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

object (GoogleAdsRow)

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

nextPageToken

string

Sayfalara ayırma jetonu, sonraki sonuç sayfasını almak için kullanılır. Bu dizenin içeriğini, sonraki isteğin pageToken özelliği olarak iletin. nextPageToken, son sayfa için döndürülmez.

totalResultsCount

string (int64 format)

LIMIT yantümcesi yok sayıldığında, sorguyla eşleşen toplam sonuç sayısı.

fieldMask

string (FieldMask format)

Kullanıcının istediği alanları temsil eden FieldMask.

Bu, tam nitelikli alan 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ı. Metriklerin özeti, tüm sonuçlardaki metriklerin toplanması anlamına gelir. Burada toplama, toplam, ortalama, oran vb. olabilir.

queryResourceConsumption

string (int64 format)

Sorguyu sunmak için harcanan kaynak miktarı.

Yetkilendirme kapsamları

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

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

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.