Method: query.suggest

Sorguyu otomatik olarak tamamlama önerileri sunar.

Not: Bu API'nin çalıştırılması için standart bir son kullanıcı hesabı gerekir. Hizmet hesapları, Query API isteklerini doğrudan gerçekleştiremez. Sorgu yürütmek için bir hizmet hesabı kullanmak istiyorsanız Google Workspace alanı genelinde yetki verme işlemini 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 metni aşağıdaki yapıyla birlikte verileri 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 "deniz" ise sunucu "mevsim", "arama", "martı" vb. kelimeler döndürebilir.
dataSourceRestrictions[]

object (DataSourceRestriction)

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

NOT: Öneriler yalnızca aşağıdaki kaynaklarda 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:

suggest API'nin 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 bakı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ğı.
Birlik alanı suggestion. Önerilen sorgu hakkında ek meta veriler içerir. Ayrıca, önerilen sorgunun türünü de belirtir. Örneğin, PeopleSuggestion mevcutsa suggested_query'nin kişi önerisi olduğunu gösterir. suggestion yalnızca aşağıdakilerden biri olabilir:
querySuggestion

object (QuerySuggestion)

Önerilen sorgu bir kelime/kelime öbeği tamamlama işlemiyse bu alan mevcut olur.
peopleSuggestion

object (PeopleSuggestion)

Bu simge, öneri bir kişiyi gösterdiğinde gösterilir. Bu kimlik, kişiyle ilgili daha fazla bilgi (ör. e-posta kimliği, ad) içerir.

QuerySuggestion

Bu alan şu anda hiçbir şey içermez ve yalnızca önerilen sonucun bir kelime öbeği tamamlama olduğunun göstergesi olarak kullanılı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.