Method: query.suggest

Udostępnia sugestie dotyczące automatycznego uzupełniania zapytania.

Uwaga: do uruchomienia tego interfejsu API wymagane jest standardowe konto użytkownika. Konto usługi nie może bezpośrednio wykonywać żądań interfejsu Query 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 żądań, takie jak wyszukiwarka czy strefa czasowa użytkownika.
query

string

Częściowe zapytanie, w przypadku którego będą wyświetlane sugestie autouzupełniania. Jeśli na przykład zapytanie to „morze”, serwer może zwrócić słowa „sezon”, „search”, „seagull” i tak dalej.
dataSourceRestrictions[]

object (DataSourceRestriction)

Źródła na potrzeby sugestii. Jeśli tego nie zrobisz, źródła danych zostaną pobrane z bieżącej wyszukiwarki.

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

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

Treść odpowiedzi

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

Odpowiedź interfejsu API sugestii.

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

object (SuggestResult)

Lista sugestii.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.

SuggestResult

1 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

Sugerowane zapytanie, które zostanie użyte przy wyszukiwaniu, gdy użytkownik kliknie sugestię
source

object (Source)

Źródło sugestii.
Pole sumy suggestion. Zawiera dodatkowe metadane dotyczące sugerowanego zapytania. Wskazuje też typ sugerowanego zapytania. Na przykład: Jeśli obecna jest sugestia Peoplesuggestion, wskazuje ona, że prompt_query to sugestia osoby. suggestion może mieć tylko jedną z tych wartości:
querySuggestion

object (QuerySuggestion)

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

object (PeopleSuggestion)

Ten element jest dostępny, gdy sugestia wskazuje osobę. Zawiera on dodatkowe informacje o osobie, takie jak identyfikator e-mail, imię i nazwisko itp.

QuerySuggestion

To pole obecnie nie zawiera żadnych danych i jest używane tylko jako wskaźnik, że proponowany wynik to pełne wyrażenie.

PeopleSuggestion

To pole zawiera informacje na temat sugerowanej osoby.

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

object (Person)

Sugerowana osoba. Wszystkie pola obiektu osoby mogą nie być wypełnione.