Method: query.debugSearch

Cloud Search sorgu API'si, arama yöntemini sağlar ve hata ayıklama bilgilerini döndürür.

Not: Bu API'nin çalıştırılması için standart bir son kullanıcı hesabı gerekir. Hizmet hesapları doğrudan sorgu API'si istekleri gönderemez. Sorgu yapmak için bir hizmet hesabı kullanmak istiyorsanız Google Workspace alanı genelinde yetki verme özelliğini ayarlayın.

HTTP isteği

POST https://cloudsearch.googleapis.com/v1/query:debugSearch

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

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
Alanlar
requestOptions

object (RequestOptions)

Arama uygulaması ve kullanıcı saat dilimi gibi istek seçenekleri.
query

string

Ham sorgu dizesi. Operatörlerden yararlanarak aramanızı daraltma başlıklı makalede desteklenen arama operatörlerini görebilirsiniz.
pageSize

integer

Bir sayfada döndürülecek maksimum arama sonucu sayısı. Geçerli değerler 1 ile 100 arasındadır (1 ve 100 dahil). Varsayılan değer 10'dur. 2000'den fazla sonuç istendiğinde minimum değer 50'dir.
start

integer

Sonuçların başlangıç dizini.
dataSourceRestrictions[]

object (DataSourceRestriction)

Sorgu için kullanılacak kaynaklar. Belirtilmezse geçerli arama uygulamasındaki tüm veri kaynakları kullanılır.
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

Arama sonuçlarını sıralama seçenekleri
queryInterpretationOptions

object (QueryInterpretationOptions)

seçenekleri vardır.
contextAttributes[]

object (ContextAttribute)

Arama sonuçlarının sıralamasını ayarlamak için kullanılacak istek bağlamı özellikleri. Maksimum öğe sayısı 10'dur.

Yanıt gövdesi

query.search yanıtında hata ayıklama

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

JSON gösterimi 
{
  "searchResponse": {
    object (SearchResponse)
  },
  "gsrRequest": string,
  "gsrResponse": string
}
Alanlar
searchResponse

object (SearchResponse)

Query.search yanıtı.
gsrRequest

string (bytes format)

GenericSearchRequest'in serileştirilmiş dizesi.

Base64 kodlu bir dize.
gsrResponse

string (bytes format)

GenericSearchResponse sınıfının serileştirilmiş dizesi.

Base64 kodlu bir dize.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.