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 .
Тело запроса
Тело запроса содержит данные следующей структуры:
| Поля |
|---|
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 .
Тело запроса
Тело запроса содержит данные следующей структуры:
| Поля |
|---|
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
Дополнительную информацию см. в руководстве по авторизации .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 2025-07-25 UTC."],[],[],null,["# Method: query.search\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nThe Cloud Search query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party.\n\n**Note:** This API requires a standard end user account to execute. A service account can't perform query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).\n\n### HTTP request\n\n`POST https://cloudsearch.googleapis.com/v1/query/search`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestOptions\": { object (/workspace/cloud-search/docs/reference/rest/v1/RequestOptions) }, \"query\": string, \"pageSize\": integer, \"start\": integer, \"dataSourceRestrictions\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications#DataSourceRestriction) } ], \"facetOptions\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications#FacetOptions) } ], \"sortOptions\": { object (/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications#SortOptions) }, \"queryInterpretationOptions\": { object (/workspace/cloud-search/docs/reference/rest/v1/QueryInterpretationOptions) }, \"contextAttributes\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ContextAttribute) } ] } ``` |\n\n| Fields ||\n|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestOptions` | `object (`[RequestOptions](/workspace/cloud-search/docs/reference/rest/v1/RequestOptions)`)` Request options, such as the search application and user timezone. |\n| `query` | `string` The raw query string. See supported search operators in the [Narrow your search with operators](https://support.google.com/cloudsearch/answer/6172299) |\n| `pageSize` | `integer` Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. Minimum value is 50 when results beyond 2000 are requested. |\n| `start` | `integer` Starting index of the results. |\n| `dataSourceRestrictions[]` | `object (`[DataSourceRestriction](/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications#DataSourceRestriction)`)` The sources to use for querying. If not specified, all data sources from the current search application are used. |\n| `facetOptions[]` | `object (`[FacetOptions](/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications#FacetOptions)`)` |\n| `sortOptions` | `object (`[SortOptions](/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications#SortOptions)`)` The options for sorting the search results |\n| `queryInterpretationOptions` | `object (`[QueryInterpretationOptions](/workspace/cloud-search/docs/reference/rest/v1/QueryInterpretationOptions)`)` options to interpret the user query. |\n| `contextAttributes[]` | `object (`[ContextAttribute](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ContextAttribute)`)` Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10. |\n\n### Response body\n\nIf successful, the response body contains an instance of [SearchResponse](/workspace/cloud-search/docs/reference/rest/v1/SearchResponse).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud_search.query`\n- `https://www.googleapis.com/auth/cloud_search`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
