Method: customers.searchAds360.search

Arama 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: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 metni aşağıdaki yapıyla birlikte verileri 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. Sonuçların bir sonraki sayfasını istemek için önceki yanıttaki nextPageToken parametresinden 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 ise istek doğrulanır ancak yürütülmez.
returnTotalResultsCount

boolean

True (doğru) ise, LIMIT ifadesi yok sayılarak, sorguyla eşleşen toplam sonuç sayısı yanıta dahil edilir. Varsayılan değer yanlıştır.
summaryRowSetting

enum (SummaryRowSetting)

Özet satırının döndürülüp döndürülmeyeceğini belirler. Özet satırı varsayılan olarak 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

SearchAds360Service.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 (SearchAds360Row)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ]
}
Alanlar
results[]

object (SearchAds360Row)

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

string

Sonuçların bir sonraki sayfasını almak için kullanılan sayfalandırma jetonu. Bu dizenin içeriğini bir sonraki isteğin pageToken özelliği olarak iletin. nextPageToken, son sayfa için döndürülmez.
totalResultsCount

string (int64 format)

LIMIT ifadesi yok sayılarak, sorguyla eşleşen toplam sonuç sayısı.
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 (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 boyutlarının başlıkları.
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

Sonuçlardaki ham etkinlik dönüşüm metriklerinin üstbilgileri.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Sonuçlardaki ham etkinlik dönüşümü boyutlarının üstbilgileri.

Yetkilendirme kapsamları

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

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