Method: settings.searchapplications.patch
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Обновляет приложение поиска.
Примечание. Для выполнения этого API требуется учетная запись администратора.
HTTP-запрос
PATCH https://cloudsearch.googleapis.com/v1/settings/{searchApplication.name=searchapplications/*}
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры |
---|
searchApplication.name | string Имя приложения поиска. Формат: searchapplications/{applicationId}. |
Параметры запроса
Параметры |
---|
updateMask | string ( FieldMask format) Применяется только к settings.searchapplications.patch . Маска обновления, чтобы контролировать, какие поля обновлять. Примеры путей к полям: searchApplication.name , searchApplication.displayName . - Если
updateMask не пуст, то обновляются только поля, указанные в updateMask . - Если вы укажете поле в
updateMask , но не укажете его значение в searchApplication , то это поле будет очищено. - Если
updateMask отсутствует, пуст или имеет значение * , то все поля обновляются.
|
Тело запроса
Тело запроса содержит экземпляр SearchApplication
.
Тело ответа
В случае успеха тело ответа содержит экземпляр Operation
.
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/cloud_search.settings.query
-
https://www.googleapis.com/auth/cloud_search.settings
-
https://www.googleapis.com/auth/cloud_search
Дополнительную информацию см. в руководстве по авторизации .
,
Обновляет приложение поиска.
Примечание. Для выполнения этого API требуется учетная запись администратора.
HTTP-запрос
PATCH https://cloudsearch.googleapis.com/v1/settings/{searchApplication.name=searchapplications/*}
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры |
---|
searchApplication.name | string Имя приложения поиска. Формат: searchapplications/{applicationId}. |
Параметры запроса
Параметры |
---|
updateMask | string ( FieldMask format) Применяется только к settings.searchapplications.patch . Маска обновления, чтобы контролировать, какие поля обновлять. Примеры путей к полям: searchApplication.name , searchApplication.displayName . - Если
updateMask не пуст, то обновляются только поля, указанные в updateMask . - Если вы укажете поле в
updateMask , но не укажете его значение в searchApplication , то это поле будет очищено. - Если
updateMask отсутствует, пуст или имеет значение * , то все поля обновляются.
|
Тело запроса
Тело запроса содержит экземпляр SearchApplication
.
Тело ответа
В случае успеха тело ответа содержит экземпляр Operation
.
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/cloud_search.settings.query
-
https://www.googleapis.com/auth/cloud_search.settings
-
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: settings.searchapplications.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates a search application.\n\n**Note:** This API requires an admin account to execute.\n\n### HTTP request\n\n`PATCH https://cloudsearch.googleapis.com/v1/settings/{searchApplication.name=searchapplications/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------------------|------------------------------------------------------------------------------------------|\n| `searchApplication.name` | `string` The name of the Search Application. Format: searchapplications/{applicationId}. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Only applies to [`settings.searchapplications.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `searchApplication.name`, `searchApplication.displayName`. - If `updateMask` is non-empty, then only the fields specified in the `updateMask` are updated. - If you specify a field in the `updateMask`, but don't specify its value in the `searchApplication`, then that field is cleared. - If the `updateMask` is not present or empty or has the value `*`, then all fields are updated. |\n\n### Request body\n\nThe request body contains an instance of [SearchApplication](/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications#SearchApplication).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/workspace/cloud-search/docs/reference/rest/v1/operations#Operation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud_search.settings.query`\n- `https://www.googleapis.com/auth/cloud_search.settings`\n- `https://www.googleapis.com/auth/cloud_search`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]