Method: query.suggest

Предоставляет предложения по автозаполнению запроса.

Примечание. Для выполнения этого API требуется стандартная учетная запись конечного пользователя. Учетная запись службы не может напрямую выполнять запросы к API; Чтобы использовать сервисный аккаунт для выполнения запросов, настройте делегирование полномочий Google Workspace на уровне всего домена .

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
Поля
requestOptions

object ( RequestOptions )

Параметры запроса, такие как приложение поиска и часовой пояс пользователя.

query

string

Частичный запрос, для которого будут показаны предложения автозаполнения. Например, если запрос «море», сервер может вернуть «сезон», «поиск», «чайка» и т. д.

dataSourceRestrictions[]

object ( DataSourceRestriction )

Источники, которые можно использовать для предложений. Если не указано, источники данных берутся из текущего приложения поиска.

ПРИМЕЧАНИЕ. Предложения поддерживаются только для следующих источников:

  • Сторонние источники данных
  • Предопределенный источник.PERSON
  • Предопределенный источник.GOOGLE_DRIVE

Тело ответа

Ответ предлагаемого API.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
Поля
suggestResults[]

object ( SuggestResult )

Список предложений.

Области авторизации

Требуется одна из следующих областей OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .

Предложитьрезультат

Результат одного предложения.

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.
}
Поля
suggestedQuery

string

Предлагаемый запрос, который будет использоваться для поиска, когда пользователь нажимает на предложение.

source

object ( Source )

Источник предложения.

suggestion по полю Союза. Содержит дополнительные метаданные о предложенном запросе. Здесь также указывается тип предлагаемого запроса. Например, если присутствует PeopleSuggestion, это означает, что предложенный_запрос — это предложение человека. suggestion может быть только одним из следующих:
querySuggestion

object ( QuerySuggestion )

Это поле будет присутствовать, если предлагаемый запрос представляет собой завершение слова/фразы.

peopleSuggestion

object ( PeopleSuggestion )

Это присутствует, когда внушение указывает на человека. Он содержит дополнительную информацию о человеке, например, его адрес электронной почты, имя и т. д.

ЗапросПредложение

Этот тип не имеет полей.

На данный момент это поле ничего не содержит и используется просто как индикатор того, что результатом предложения было завершение фразы.

ЛюдиПредложение

Это поле содержит информацию о предлагаемом человеке.

JSON-представление 
{
  "person": {
    object (Person)
  }
}
Поля
person

object ( Person )

Рекомендуемый человек. Возможно, не все поля объекта person заполнены.