Method: settings.searchapplications.patch
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Cập nhật ứng dụng tìm kiếm.
Lưu ý: API này yêu cầu tài khoản quản trị để thực thi.
Yêu cầu HTTP
PATCH https://cloudsearch.googleapis.com/v1/settings/{searchApplication.name=searchapplications/*}
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Thông số |
searchApplication.name |
string
Tên của Ứng dụng tìm kiếm. Định dạng: searchapplications/{applicationId}.
|
Tham số truy vấn
Thông số |
updateMask |
string (FieldMask format)
Chỉ áp dụng cho settings.searchapplications.patch . Cập nhật mặt nạ để kiểm soát những trường cần cập nhật. Ví dụ về đường dẫn trường: searchApplication.name , searchApplication.displayName .
- Nếu
updateMask không trống, thì chỉ những trường được chỉ định trong updateMask mới được cập nhật.
- Nếu bạn chỉ định một trường trong
updateMask nhưng không chỉ định giá trị của trường đó trong searchApplication , thì trường đó sẽ bị xoá.
- Nếu không có
updateMask hoặc trường này trống hoặc có giá trị * , thì tất cả các trường sẽ được cập nhật.
|
Nội dung yêu cầu
Nội dung yêu cầu chứa một bản sao của SearchApplication
.
Nội dung phản hồi
Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Operation
.
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau:
https://www.googleapis.com/auth/cloud_search.settings.query
https://www.googleapis.com/auth/cloud_search.settings
https://www.googleapis.com/auth/cloud_search
Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-07-25 UTC.
[null,null,["Cập nhật lần gần đây nhất: 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)."]]