REST Resource: indexing.datasources.items

{
  "name": string,
  "acl": {
    object (ItemAcl)
  },
  "metadata": {
    object (ItemMetadata)
  },
  "structuredData": {
    object (ItemStructuredData)
  },
  "content": {
    object (ItemContent)
  },
  "version": string,
  "status": {
    object (ItemStatus)
  },
  "queue": string,
  "payload": string,
  "itemType": enum (Item.ItemType)
}

string

O nome do item. Formato: fontes de dados/{sourceId}/items/{itemId}

Este campo é obrigatório. O tamanho máximo é de 1.536 caracteres.

object (ItemAcl)

Lista de controle de acesso para este item.

object (ItemMetadata)

As informações dos metadados.

object (ItemStructuredData)

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.

object (ItemContent)

Conteúdo do item a ser indexado e o texto pesquisável.

string (bytes format)

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.

object (ItemStatus)

Status do item. Campo somente de saída.

string

Colocar este item na fila. O comprimento máximo é de 100 caracteres.

string (bytes format)

O conector de estado adicional pode armazenar para este item. O tamanho máximo é de 10.000 bytes.

Uma string codificada em base64.

enum (Item.ItemType)

O tipo deste item.

{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}

string

O nome do item do qual herdar a lista de permissões de acesso (ACL). Observação: a herança da ACL só fornece permissões de acesso para itens filhos, não define relações estruturais, nem oferece maneiras convenientes de excluir grandes grupos de itens. Excluir um pai da ACL do índice altera somente as permissões de acesso dos itens filhos que fazem referência ao pai no campo inheritAclFrom. O item ainda está no índice, mas pode não aparecer nos resultados da pesquisa. Por outro lado, a exclusão de um item de contêiner também exclui todos os itens que fazem referência ao contêiner por meio do campo containerName. O tamanho máximo desse campo é de 1.536 caracteres.

enum (ItemAcl.AclInheritanceType)

Define o tipo de regras de acesso a serem aplicadas quando um item herda a ACL de um pai. Isso sempre precisa ser definido em conjunto com o campo inheritAclFrom. Além disso, quando o campo inheritAclFrom é definido, ele precisa ser definido como um AclInheritanceType válido.

object (Principal)

Lista dos principais que têm permissão para ver o item nos resultados da pesquisa. Opcional se herdar permissões de outro item ou se o item não tiver a intenção de ficar visível, como virtual containers. O número máximo de elementos é 1.000.

object (Principal)

Lista de principais com acesso negado explicitamente ao item nos resultados da pesquisa. Embora os principais tenham acesso negado por padrão, use leitores negados para lidar com exceções e substituir a lista de leitores permitidos. O número máximo de elementos é 100.

object (Principal)

Opcional. Lista de proprietários do item. Este campo não afeta as permissões de acesso a documentos. No entanto, ele oferece uma pequena classificação de itens em que o usuário que faz a consulta é um proprietário. O número máximo de elementos é cinco.

{

  // Union field principal can be only one of the following:
  "gsuitePrincipal": {
    object (GSuitePrincipal)
  },
  "userResourceName": string,
  "groupResourceName": string
  // End of list of possible types for union field principal.
}

object (GSuitePrincipal)

Este principal é um usuário, grupo ou domínio do Google Workspace.

string

Este principal é um usuário identificado com uma identidade externa. O campo de nome deve especificar o nome do recurso do usuário com este formato: identitysources/{sourceId}/users/{ID}

string

Este principal é um grupo identificado com o uso de uma identidade externa. O campo de nome deve especificar o nome do recurso de grupo com este formato: identitysources/{sourceId}/groups/{ID}

{
  "title": string,
  "sourceRepositoryUrl": string,
  "containerName": string,
  "objectType": string,
  "createTime": string,
  "updateTime": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "contentLanguage": string,
  "mimeType": string,
  "searchQualityMetadata": {
    object (SearchQualityMetadata)
  },
  "keywords": [
    string
  ],
  "hash": string,
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}

string

Título do item. Se fornecido, será o título exibido do resultado query.search. O tamanho máximo é de 2.048 caracteres.

string

Link para o repositório de origem que exibe os dados. Os resultados da pesquisa aplicam esse link ao título. Espaços em branco ou caracteres especiais podem fazer com que os links de resultados do Cloud Search acionem um aviso de redirecionamento. Para evitar isso, codifique o URL. O tamanho máximo é de 2.048 caracteres.

string

O nome do contêiner deste item. A exclusão do item de contêiner leva à exclusão automática do item. Observação: as ACLs não são herdadas de um item de contêiner. Para fornecer a herança de ACL a um item, use o campo inheritAclFrom. O tamanho máximo é de 1.536 caracteres.

string

Tipo do item. Precisa corresponder ao nome de uma definição de objeto no esquema registrado para a fonte de dados. Por exemplo, se o esquema da origem de dados contiver uma definição de objeto com o nome "document", as solicitações de indexação de itens para objetos desse tipo deverão definir objectType como "document". O tamanho máximo é de 256 caracteres.

string (Timestamp format)

A hora em que o item foi criado no repositório de origem.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

A hora em que o item foi modificado pela última vez no repositório de origem.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

object (Interaction)

Uma lista de interações para o item. As interações são usadas para melhorar a qualidade de query.search, mas não são expostas aos usuários finais. O número máximo de elementos é 1.000.

string

O código de idioma BCP-47 do item, como "pt-BR" ou "sr-Latn". Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. O tamanho máximo é de 32 caracteres.

string

O tipo MIME original de ItemContent.content no repositório de origem. O tamanho máximo é de 256 caracteres.

object (SearchQualityMetadata)

Metadados adicionais de qualidade de pesquisa do item

string

Palavras-chave ou frases adicionais que devem corresponder ao item. Usado internamente para conteúdo gerado pelo usuário. O número máximo de elementos é 100. O tamanho máximo é de 8.192 caracteres.

string

Valor de hash fornecido pelo autor da chamada da API. Isso pode ser usado com o método items.push para calcular o estado modificado. O tamanho máximo é de 2.048 caracteres.

object (ContextAttribute)

Um conjunto de atributos nomeados associados ao item. Isso pode ser usado para influenciar a classificação do item com base no contexto da solicitação. O número máximo de elementos é 10.

{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}

enum (Interaction.InteractionType)

object (Principal)

O usuário que realizou a ação no item.

string (Timestamp format)

A hora em que o usuário agiu no item. Se várias ações do mesmo tipo existirem para um único usuário, somente a ação mais recente será registrada.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

{
  "quality": number
}

number

Indica a qualidade do item, usada para influenciar a qualidade da pesquisa. o valor deve estar entre 0,0 (qualidade mais baixa) e 1,0 (qualidade mais alta). O valor padrão é 0,0.

{
  "name": string,
  "values": [
    string
  ]
}

string

O nome do atributo. Ele não deve ficar vazio. O tamanho máximo é de 32 caracteres. O nome precisa começar com uma letra e só pode conter letras (A-Z, a-z) ou números (0-9). O nome será normalizado (em minúsculas) antes de ser correspondido.

string

Valores de texto do atributo. O número máximo de elementos é 10. O comprimento máximo de um elemento na matriz é de 32 caracteres. O valor será normalizado (em minúsculas) antes de ser correspondido.

{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}

object (StructuredDataObject)

O objeto de dados estruturados que precisa estar em conformidade com uma definição de objeto registrado no esquema da fonte de dados.

string

Valor de hash fornecido pelo autor da chamada da API. Isso pode ser usado com o método items.push para calcular o estado modificado. O tamanho máximo é de 2.048 caracteres.

{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}

object (NamedProperty)

As propriedades do objeto. O número máximo de elementos é 1.000.

{
  "name": string,

  // Union field value can be only one of the following:
  "integerValues": {
    object (NamedProperty.IntegerValues)
  },
  "doubleValues": {
    object (NamedProperty.DoubleValues)
  },
  "timestampValues": {
    object (NamedProperty.TimestampValues)
  },
  "booleanValue": boolean,
  "objectValues": {
    object (NamedProperty.ObjectValues)
  },
  "enumValues": {
    object (NamedProperty.EnumValues)
  },
  "dateValues": {
    object (NamedProperty.DateValues)
  },
  "textValues": {
    object (NamedProperty.TextValues)
  },
  "htmlValues": {
    object (NamedProperty.HtmlValues)
  }
  // End of list of possible types for union field value.
}

string

O nome da propriedade. Esse nome precisa corresponder ao nome da propriedade que foi registrada para a definição do objeto no esquema. O tamanho máximo permitido para essa propriedade é de 256 caracteres.

object (NamedProperty.IntegerValues)

object (NamedProperty.DoubleValues)

object (NamedProperty.TimestampValues)

boolean

object (NamedProperty.ObjectValues)

object (NamedProperty.EnumValues)

object (NamedProperty.DateValues)

object (NamedProperty.TextValues)

object (NamedProperty.HtmlValues)

{
  "values": [
    string
  ]
}

string (int64 format)

{
  "values": [
    number
  ]
}

number

{
  "values": [
    string
  ]
}

string (Timestamp format)

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}

object (StructuredDataObject)

{
  "values": [
    string
  ]
}

string

O tamanho máximo permitido para valores de string é de 32 caracteres.

{
  "values": [
    {
      object (Date)
    }
  ]
}

object (Date)

{
  "values": [
    string
  ]
}

string

O tamanho máximo permitido para valores de texto é de 2.048 caracteres.

{
  "values": [
    string
  ]
}

string

O tamanho máximo permitido para valores html é 2.048 caracteres.

{
  "contentFormat": enum (ItemContent.ContentFormat),
  "hash": string,

  // Union field content can be only one of the following:
  "inlineContent": string,
  "contentDataRef": {
    object (UploadItemRef)
  }
  // End of list of possible types for union field content.
}

enum (ItemContent.ContentFormat)

string

Informações de hash calculadas e fornecidas pelo cliente da API para o conteúdo. Pode ser usado com o método items.push para calcular o estado modificado. O tamanho máximo é de 2.048 caracteres.

string (bytes format)

Conteúdo fornecido em linha no método de atualização. O tamanho máximo é de 102.400 bytes (100 KiB).

Uma string codificada em base64.

object (UploadItemRef)

Fazer upload do ID de referência de um conteúdo enviado anteriormente pelo método de gravação.

{
  "name": string
}

string

O nome da referência do conteúdo. O tamanho máximo é de 2.048 caracteres.

{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}

enum (ItemStatus.Code)

Código de status.

object (ProcessingError)

Detalhes do erro caso o item esteja no estado ERRO.

object (RepositoryError)

Erro no repositório relatado pelo conector.

{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}

enum (ProcessingErrorCode)

Código de erro que indica a natureza do erro.

string

A descrição do erro.

object (FieldViolation)

Caso os campos do item sejam inválidos, ele vai conter os detalhes sobre os erros de validação.

{
  "field": string,
  "description": string
}

string

Caminho do campo com violação.

string

A descrição do erro.

{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}

enum (RepositoryError.Type)

O tipo de erro.

integer

Códigos de erro. Corresponde à definição de códigos de status HTTP.

string

Mensagem que descreve o erro. O tamanho máximo permitido da mensagem é de 8.192 caracteres.