- Żądanie HTTP
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- SuggestResult
- QuerySuggestion
- PeopleSuggestion
- Wypróbuj
Wyświetla sugestie automatycznego uzupełniania zapytania.
Uwaga: do wykonania tego interfejsu API wymagane jest standardowe konto użytkownika. Konto usługi nie może bezpośrednio wykonywać żądań do 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 ( |
Pola | |
---|---|
requestOptions |
Opcje żądania, takie jak wyszukiwarka i strefa czasowa użytkownika. |
query |
Częściowe zapytanie, dla którego będą wyświetlane sugestie autouzupełniania. Jeśli zapytanie to np. „morze”, serwer może zwrócić te słowa: „session”, „search”, „seamea” itd. |
dataSourceRestrictions[] |
Źródła, na podstawie których wyświetlane są sugestie. Jeśli ich nie określisz, źródła danych będą pobierane z bieżącej wyszukiwarki. UWAGA: sugestie są obsługiwane tylko w przypadku tych źródeł:
|
Treść odpowiedzi
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Odpowiedź interfejsu API sugestii.
Zapis JSON |
---|
{
"suggestResults": [
{
object ( |
Pola | |
---|---|
suggestResults[] |
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 po autoryzacji.
SuggestResult
1 sugestia.
Zapis JSON |
---|
{ "suggestedQuery": string, "source": { object ( |
Pola | |
---|---|
suggestedQuery |
Sugerowane zapytanie, które zostanie użyte do wyszukiwania, gdy użytkownik kliknie sugestię |
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 występuje wyrażenie PeopleSuggestion, oznacza to, że sugerowane_zapytanie to sugerowana osoba. suggestion może mieć tylko jedną z tych wartości: |
|
querySuggestion |
To pole jest obecne, jeśli sugerowane zapytanie zawiera uzupełnienie słowa lub wyrażenia. |
peopleSuggestion |
Jest on używany, gdy sugestia wskazuje osobę. Zawiera on więcej informacji o danej osobie, np. jej identyfikator e-mail, imię i nazwisko itp. |
QuerySuggestion
Na razie to pole nie zawiera żadnych danych i jest używane tylko jako wskaźnik, że wynik sugestii to dokończenie wyrażenia.
PeopleSuggestion
To pole zawiera informacje o sugerowanej osobie.
Zapis JSON |
---|
{
"person": {
object ( |
Pola | |
---|---|
person |
Sugerowana osoba. Żadne pola obiektu osoby mogą nie być wypełnione. |