- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- IndexItemOptions
- Pruébala
Actualiza la LCA, los metadatos y el contenido de Item
. Insertará el Item
si no existe. Este método no admite actualizaciones parciales. Los campos sin valores proporcionados se borran del índice de Cloud Search.
Esta API requiere una cuenta de administrador o de servicio para ejecutarse. La cuenta de servicio utilizada es la que está incluida en la lista blanca de la fuente de datos correspondiente.
Solicitud HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
item.name |
Es el nombre del artículo. Formato: fuentes de datos/{sourceId}/items/{itemId} Éste es un campo obligatorio. La longitud máxima es de 1,536 caracteres. |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "item": { "name": string, "acl": { "inheritAclFrom": string, "aclInheritanceType": enum ( |
Campos | |
---|---|
item.acl |
Lista de control de acceso para este elemento. |
item.metadata |
La información de los metadatos. |
item.structuredData |
Los datos estructurados del elemento que debe coincidir con una definición de objeto registrada en el esquema de la fuente de datos. |
item.content |
Contenido del elemento que se indexará y que se pueda buscar el texto. |
item.version |
Obligatorio. El sistema de indexación almacena la versión de la fuente de datos como una string de bytes y compara la versión del elemento en el índice con la versión del elemento en cola mediante el orden léxico. La indexación de Cloud Search no indexará ni borrará ningún elemento en cola con un valor de versión inferior o igual a la versión del elemento indexado actualmente. La longitud máxima de este campo es de 1,024 bytes. Para obtener información sobre cómo la versión del elemento afecta el proceso de eliminación, consulta el artículo Cómo manejar revisiones después de eliminaciones manuales. String codificada en base64. |
item.status |
Es el estado del artículo. Es el campo de solo salida. |
item.queue |
Fila a la que pertenece este elemento. La longitud máxima es de 100 caracteres. |
item.payload |
El conector de estado adicional puede almacenar este elemento. La longitud máxima es de 10,000 bytes. String codificada en base64. |
item.itemType |
Es el tipo de este elemento. |
connectorName |
El nombre del conector que realiza esta llamada. Formato: fuentes de datos/{sourceId}/conectores/{ID} |
mode |
Obligatorio. El RequestMode para esta solicitud. |
debugOptions |
Opciones de depuración comunes. |
indexItemOptions |
|
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation
.
Alcances de la autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
Para obtener más información, consulta la guía de autorización.
IndexItemOptions
Representación JSON |
---|
{ "allowUnknownGsuitePrincipals": boolean } |
Campos | |
---|---|
allowUnknownGsuitePrincipals |
Especifica si la solicitud de índice debe permitir principales de Google Workspace que no existen o que se borran. |