Method: customers.searchAds360.search

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

Oluşan hataların listesi: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError 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 metni

İstek içeriği 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 değerini 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ırlamaya karar verebilir.

validateOnly

boolean

Doğruysa istek doğrulanır ancak yürütülmez.

returnTotalResultsCount

boolean

Doğruysa LIMIT ifadesi yoksayılarak sorguyla eşleşen sonuçların toplam sayısı yanıta dahil edilir. Varsayılan değer false'tur.

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 yanıtta tek başına gönderilir.

Yanıt metni

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 sonraki sayfasını almak için kullanılan sayfalama jetonu. 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 ifadesi yoksayılarak sorguyla eşleşen toplam sonuç sayısı.

fieldMask

string (FieldMask format)

Kullanıcının hangi alanları istediğini gösteren FieldMask.

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

summaryRow

object (SearchAds360Row)

Sonuçlardaki metriklerin özetini içeren özet satırı. Metriklerin özeti, tüm sonuçlardaki metriklerin toplandığı anlamına gelir. Burada toplama işlemi; 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 başlıkları.

rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

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

Yetkilendirme kapsamları

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

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