Method: query.suggest

Sorgunun otomatik olarak tamamlanması için öneriler sunar.

Not: Bu API'nin yürütülmesi için standart bir son kullanıcı hesabı gerekir. Bir hizmet hesabı, Query API isteklerini doğrudan gerçekleştiremez. Sorgu gerçekleştirmek amacıyla bir hizmet hesabı kullanmak için Google Workspace alanı genelinde yetki verme ayarlarını yapın.

HTTP isteği

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

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

İstek içeriği

İstek gövdesi, aşağıdaki yapıyla birlikte veriler içerir:

JSON gösterimi 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
Alanlar
requestOptions

object (RequestOptions)

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

string

Otomatik tamamlama önerilerinin gösterileceği kısmi sorgu. Örneğin, sorgu "sea" ise sunucu "season", "search", "seagull" vb. döndürebilir.
dataSourceRestrictions[]

object (DataSourceRestriction)

Öneriler için kullanılacak kaynaklar. Belirtilmezse veri kaynakları mevcut arama uygulamasından alınır.

NOT: Öneriler yalnızca aşağıdaki kaynaklar için desteklenir:

  • Üçüncü taraf veri kaynakları
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

Yanıt gövdesi

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

Öneri API'sinin yanıtı.

JSON gösterimi 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
Alanlar
suggestResults[]

object (SuggestResult)

Öneri listesi.

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 göz atın.

SuggestResult

Bir öneri sonucu.

JSON gösterimi 
{
  "suggestedQuery": string,
  "source": {
    object (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
Alanlar
suggestedQuery

string

Kullanıcı öneriyi tıkladığında arama için kullanılacak önerilen sorgu
source

object (Source)

Önerinin kaynağı.
suggestion alanı. Önerilen sorguyla ilgili ek meta verileri içerir. Önerilen sorgunun türünü de gösterir. Örneğin, PeopleSuggestion varsa bu mesaj, recommended_query için kişi önerisi olduğunu belirtir. suggestion şunlardan yalnızca biri olabilir:
querySuggestion

object (QuerySuggestion)

Önerilen sorgu bir kelime/kelime öbeği tamamlamaysa bu alan gösterilir.
peopleSuggestion

object (PeopleSuggestion)

Öneride bir kişi belirtildiğinde bu mesaj gösterilir. Kişiyle ilgili daha fazla bilgi (ör. e-posta kimliği, adı vb.) içerir.

QuerySuggestion

Bu alan şimdilik hiçbir şey içermez ve yalnızca önerilen sonucun bir kelime öbeğinin tamamlandığına dair bir gösterge olarak kullanılmaktadır.

PeopleSuggestion

Bu alanda, önerilen kişiyle ilgili bilgiler yer alır.

JSON gösterimi 
{
  "person": {
    object (Person)
  }
}
Alanlar
person

object (Person)

Önerilen kişi. Kişi nesnesinin tüm alanları doldurulmayabilir.