Method: query.suggest

Udostępnia sugestie autouzupełniania zapytania.

Uwaga: do wykonania tej operacji wymagane jest standardowe konto użytkownika. Konto usługi nie może bezpośrednio wykonywać zapytań do interfejsu API. Aby używać konta usługi do wykonywania zapytań, skonfiguruj przekazywanie uprawnień w całej domenie Google Workspace.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
Pola
requestOptions

object (RequestOptions)

opcje zapytania, takie jak aplikacja wyszukiwania i strefa czasowa użytkownika;
query

string

Częściowe zapytanie, dla którego będą wyświetlane sugestie autouzupełniania. Jeśli na przykład zapytanie brzmi „sea” (morze), serwer może zwrócić „season” (sezon), „search” (szukać), „seagull” (mewa) itd.
dataSourceRestrictions[]

object (DataSourceRestriction)

Źródła używane do tworzenia sugestii. Jeśli nie są określone, źródła danych pochodzą z bieżącej aplikacji wyszukiwania.

Uwaga: sugestie są obsługiwane tylko w przypadku tych źródeł:

  • Źródła danych innych firm
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

Treść odpowiedzi

Odpowiedź interfejsu API suggest.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
Pola
suggestResults[]

object (SuggestResult)

Lista sugestii.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.

SuggestResult

Jeden wynik sugestii.

Zapis JSON 
{
  "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.
}
Pola
suggestedQuery

string

Zaproponowane zapytanie, które zostanie użyte do wyszukiwania, gdy użytkownik kliknie sugestię
source

object (Source)

Źródło sugestii.
Pole unii suggestion. Zawiera dodatkowe metadane dotyczące sugerowanego zapytania. Wskazuje też typ sugerowanego zapytania. Jeśli na przykład występuje parametr PeopleSuggestion, oznacza to, że suggested_query to sugestia dotycząca osoby. suggestion może być tylko jednym z tych elementów:
querySuggestion

object (QuerySuggestion)

To pole będzie widoczne, jeśli sugerowane zapytanie jest uzupełnieniem słowa lub wyrażenia.
peopleSuggestion

object (PeopleSuggestion)

Jest widoczna, gdy sugestia dotyczy osoby. Zawiera on więcej informacji o tej osobie, np. adres e-mail, imię i nazwisko.

QuerySuggestion

Ten typ nie ma pól.

Obecnie to pole nie zawiera niczego i służy tylko jako wskaźnik, że wynik sugestii był uzupełnieniem frazy.

PeopleSuggestion

To pole zawiera informacje o osobach, które są sugerowane.

Zapis JSON 
{
  "person": {
    object (Person)
  }
}
Pola
person

object (Person)

Sugerowana osoba. Nie wszystkie pola obiektu person mogą być wypełnione.