Method: query.suggest

Sorgunun otomatik tamamlanması için öneriler sağlar.

Not: Bu API'nin yürütülmesi için standart bir son kullanıcı hesabı gerekir. Bir hizmet hesabı, doğrudan Query API isteklerini 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ıya sahip verileri içerir:

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

object (RequestOptions)

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

string

Otomatik tamamlama önerilerinin gösterileceği kısmi sorgu. Örneğin, sorgu "deniz" ise sunucu "sezon", "arama", "seagull" şeklinde olabilir. vb.
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ılavuzunu inceleyin.

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ğı.
Birleştirme alanı suggestion. Önerilen sorguyla ilgili ek meta verileri içerir. Ayrıca, önerilen sorgunun türünü de gösterir. Örneğin, Kişi Önerisi varsa bu, recommended_query özelliğinin bir kişi önerisi olduğunu gösterir. suggestion şunlardan yalnızca biri olabilir:
querySuggestion

object (QuerySuggestion)

Önerilen sorgu bir kelime veya kelime öbeği tamamlamasıysa bu alan gösterilir.
peopleSuggestion

object (PeopleSuggestion)

Bu, öneride bir kişi olduğunda gösterilir. Kişiyle ilgili daha fazla bilgi (e-posta kimliği, adı vb.) içerir.

QuerySuggestion

Bu alan şu an itibarıyla hiçbir şey içermiyor ve yalnızca öneri sonucunun sıralı tamamlama olduğunun göstergesi olarak kullanılmaktadır.

PeopleSuggestion

Bu alanda, önerilen kişi hakkında bilgiler yer alır.

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

object (Person)

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