Method: settings.searchapplications.patch
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Actualiza una aplicación de búsqueda.
Nota: Esta API requiere una cuenta de administrador para ejecutarse.
Solicitud HTTP
PATCH https://cloudsearch.googleapis.com/v1/settings/{searchApplication.name=searchapplications/*}
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros |
searchApplication.name |
string
Es el nombre de la aplicación de búsqueda. Formato: searchapplications/{applicationId}.
|
Parámetros de consulta
| Parámetros |
updateMask |
string (FieldMask format)
Solo se aplica a settings.searchapplications.patch. Máscara de actualización para controlar qué campos se actualizarán. Ejemplos de rutas de campo: searchApplication.name, searchApplication.displayName.
- Si
updateMask no está vacío, solo se actualizan los campos especificados en updateMask.
- Si especificas un campo en
updateMask, pero no especificas su valor en searchApplication, ese campo se borrará.
- Si
updateMask no está presente, está vacío o tiene el valor *, todos los campos se actualizan.
|
Cuerpo de la solicitud
El cuerpo de la solicitud contiene una instancia de SearchApplication.
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.
Alcances de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/cloud_search.settings.queryhttps://www.googleapis.com/auth/cloud_search.settingshttps://www.googleapis.com/auth/cloud_search
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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)."]]
