- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos da autorização
- IndexItemOptions
- Faça um teste
Atualiza a ACL, os metadados e o conteúdo do Item
. A Item
será inserida se ela não existir. Esse método não oferece suporte a atualizações parciais. Os campos sem valores fornecidos são apagados do índice do Cloud Search.
Esta API requer uma conta de administrador ou de serviço para ser executada. A conta de serviço usada está na lista de permissões da fonte de dados correspondente.
Solicitação HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
item.name |
O nome do item. Formato: fontes de dados/{sourceId}/items/{itemId} Este campo é obrigatório. O tamanho máximo é de 1.536 caracteres. |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "item": { "name": string, "acl": { "inheritAclFrom": string, "aclInheritanceType": enum ( |
Campos | |
---|---|
item.acl |
Lista de controle de acesso para este item. |
item.metadata |
As informações dos metadados. |
item.structuredData |
São os dados estruturados do item que precisam estar em conformidade com uma definição de objeto registrado no esquema da fonte de dados. |
item.content |
Conteúdo do item a ser indexado e o texto pesquisável. |
item.version |
Obrigatório. O sistema de indexação armazena a versão da fonte de dados como uma string de bytes e compara a versão do item no índice com a versão do item na fila usando a ordem léxica. A indexação do Cloud Search não indexa nem exclui itens na fila com um valor de versão menor ou igual à versão do item indexado no momento. O tamanho máximo deste campo é de 1.024 bytes. Para mais informações sobre como a versão do item afeta o processo de exclusão, consulte Processar revisões após exclusões manuais. Uma string codificada em base64. |
item.status |
Status do item. Campo somente de saída. |
item.queue |
Colocar este item na fila. O comprimento máximo é de 100 caracteres. |
item.payload |
O conector de estado adicional pode armazenar para este item. O tamanho máximo é de 10.000 bytes. Uma string codificada em base64. |
item.itemType |
O tipo deste item. |
connectorName |
O nome do conector que está fazendo a chamada. Formato: fontes de dados/{sourceId}/connectors/{ID} |
mode |
Obrigatório. O RequestMode para esta solicitação. |
debugOptions |
Opções comuns de depuração. |
indexItemOptions |
|
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation
.
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
Para mais informações, consulte o Guia de autorização.
IndexItemOptions
Representação JSON |
---|
{ "allowUnknownGsuitePrincipals": boolean } |
Campos | |
---|---|
allowUnknownGsuitePrincipals |
Especifica se a solicitação de índice vai permitir principais do Google Workspace que não existem ou foram excluídos. |