Method: settings.searchapplications.patch
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
更新搜索应用。
注意:此 API 需要使用管理员账号才能执行。
HTTP 请求
PATCH https://cloudsearch.googleapis.com/v1/settings/{searchApplication.name=searchapplications/*}
网址采用 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
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[],[],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)."]]