Method: query.search

API запросов Cloud Search предоставляет метод поиска, который возвращает наиболее релевантные результаты пользовательского запроса. Результаты могут быть получены из приложений Google Workspace, таких как Gmail или Google Drive, или из данных, проиндексированных вами от третьих лиц.

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

HTTP-запрос

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

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

Тело запроса

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

JSON-представление 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
Поля
requestOptions

object ( RequestOptions )

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

query

string

Необработанная строка запроса. См. поддерживаемые операторы поиска в разделе «Сузьте поиск с помощью операторов».

pageSize

integer

Максимальное количество результатов поиска, возвращаемых на одной странице. Допустимые значения: от 1 до 100 включительно. Значение по умолчанию — 10. Минимальное значение — 50, если запрашиваются результаты за пределами 2000.

start

integer

Начальный индекс результатов.

dataSourceRestrictions[]

object ( DataSourceRestriction )

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

facetOptions[]

object ( FacetOptions )

sortOptions

object ( SortOptions )

Варианты сортировки результатов поиска

queryInterpretationOptions

object ( QueryInterpretationOptions )

варианты интерпретации запроса пользователя.

contextAttributes[]

object ( ContextAttribute )

Атрибуты контекста запроса, которые будут использоваться для корректировки ранжирования результатов поиска. Максимальное количество элементов — 10.

Тело ответа

В случае успеха тело ответа содержит экземпляр SearchResponse .

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

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

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

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

,

API запросов Cloud Search предоставляет метод поиска, который возвращает наиболее релевантные результаты пользовательского запроса. Результаты могут быть получены из приложений Google Workspace, таких как Gmail или Google Drive, или из данных, проиндексированных вами от третьих лиц.

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

HTTP-запрос

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

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

Тело запроса

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

JSON-представление 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
Поля
requestOptions

object ( RequestOptions )

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

query

string

Необработанная строка запроса. См. поддерживаемые операторы поиска в разделе «Сузьте поиск с помощью операторов».

pageSize

integer

Максимальное количество результатов поиска, возвращаемых на одной странице. Допустимые значения: от 1 до 100 включительно. Значение по умолчанию — 10. Минимальное значение — 50, если запрашиваются результаты за пределами 2000.

start

integer

Начальный индекс результатов.

dataSourceRestrictions[]

object ( DataSourceRestriction )

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

facetOptions[]

object ( FacetOptions )

sortOptions

object ( SortOptions )

Варианты сортировки результатов поиска

queryInterpretationOptions

object ( QueryInterpretationOptions )

варианты интерпретации запроса пользователя.

contextAttributes[]

object ( ContextAttribute )

Атрибуты контекста запроса, которые будут использоваться для корректировки ранжирования результатов поиска. Максимальное количество элементов — 10.

Тело ответа

В случае успеха тело ответа содержит экземпляр SearchResponse .

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

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

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

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