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

Nom de l'article. Format: datasources/{sourceId}/items/{itemId}

Champ obligatoire. Ne doit pas dépasser 1 536 caractères

object (ItemAcl)

Liste de contrôle d'accès pour cet élément.

object (ItemMetadata)

Informations sur les métadonnées.

object (ItemStructuredData)

Données structurées de l'élément qui doivent être conformes à une définition d'objet enregistrée dans le schéma de la source de données.

object (ItemContent)

Contenu de l'article à indexer et à rechercher dans le texte.

string (bytes format)

Obligatoire. Le système d'indexation stocke la version de la source de données sous forme de chaîne d'octets et compare la version de l'élément de l'index à la version de l'élément en file d'attente par ordre lexical.

L'indexation Cloud Search n'indexe ni ne supprime aucun élément de la file d'attente dont la valeur de version est inférieure ou égale à celle de l'élément actuellement indexé. La longueur maximale de ce champ est de 1 024 octets.

Pour en savoir plus sur l'impact de la version de l'élément sur le processus de suppression, consultez Gérer les révisions après les suppressions manuelles.

Chaîne encodée en base64.

object (ItemStatus)

État de l'article. Champ de sortie uniquement.

string

File d'attente à laquelle appartient cet élément. La longueur ne doit pas dépasser 100 caractères.

string (bytes format)

Un connecteur d'état supplémentaire peut stocker cet élément. La longueur maximale est de 10 000 octets.

Chaîne encodée en base64.

enum (Item.ItemType)

Type de cet élément.

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

string

Nom de l'élément dont hérite la liste de contrôle d'accès. Remarque: L'héritage des LCA ne donne que les autorisations d'accès aux éléments enfants. Il ne définit pas de relations structurelles et ne permet pas de supprimer facilement de grands groupes d'éléments. La suppression d'un parent de la LCA de l'index modifie uniquement les autorisations d'accès des éléments enfants qui font référence au parent dans le champ inheritAclFrom. L'élément figure toujours dans l'index, mais il se peut qu'il ne s'affiche pas dans les résultats de recherche. En revanche, la suppression d'un élément de conteneur supprime également tous les éléments qui y font référence via le champ containerName. La longueur maximale de ce champ est de 1 536 caractères.

enum (ItemAcl.AclInheritanceType)

Définit le type de règles d'accès à appliquer lorsqu'un élément hérite de la LCA d'un élément parent. Ce champ doit toujours être défini en tandem avec le champ inheritAclFrom. De plus, lorsque le champ inheritAclFrom est défini, il doit être défini sur un paramètre AclInheritanceType valide.

object (Principal)

Liste des comptes principaux autorisés à voir l'élément dans les résultats de recherche. Facultatif si vous héritez des autorisations d'un autre élément ou si l'élément n'est pas censé être visible, comme virtual containers. Le nombre d'éléments est limité à 1 000.

object (Principal)

Liste des comptes principaux qui n'ont pas été explicitement autorisés à accéder à l'élément dans les résultats de recherche. Bien que l'accès aux comptes principaux soit refusé par défaut, utilisez les lecteurs refusés pour gérer les exceptions et ignorer la liste des lecteurs autorisés. Le nombre d'éléments est limité à 100.

object (Principal)

Facultatif. Liste des propriétaires de l'élément. Ce champ n'a aucune incidence sur les autorisations d'accès aux documents. Toutefois, il offre un léger classement qui améliore les éléments dont l'utilisateur à l'origine de la requête est propriétaire. Le nombre maximal d'éléments est 5.

{

  // 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)

Ce compte principal correspond à un utilisateur, un groupe ou un domaine Google Workspace.

string

Ce compte principal est un utilisateur identifié à l'aide d'une identité externe. Le champ "name" doit spécifier le nom de la ressource utilisateur au format suivant: Identitysources/{sourceId}/users/{ID}

string

Ce compte principal est un groupe identifié à l'aide d'une identité externe. Le champ de nom doit spécifier le nom de ressource du groupe au format suivant: 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

Titre de l'article. S'il est indiqué, il s'agit du titre affiché pour le résultat de la requête. Ne doit pas dépasser 2 048 caractères

string

Lien vers le dépôt source diffusant les données. Les résultats de recherche de liens appliquent ce lien au titre. Les espaces blancs ou les caractères spéciaux peuvent entraîner l'affichage d'une notification de redirection par les liens de résultats Cloud Search. Pour éviter cela, encodez l'URL. Ne doit pas dépasser 2 048 caractères

string

Nom du conteneur pour cet élément. La suppression de l'élément de conteneur entraîne sa suppression automatique. Remarque: Les LCA ne sont pas héritées d'un élément de conteneur. Pour attribuer une LCA à un élément, utilisez le champ inheritAclFrom. Ne doit pas dépasser 1 536 caractères

string

Type de l'article. Elle doit correspondre au nom d'une définition d'objet dans le schéma enregistré pour la source de données. Par exemple, si le schéma de la source de données contient une définition d'objet nommée "document", les requêtes d'indexation d'éléments pour les objets de ce type doivent définir "objectType" sur "document". Ne doit pas dépasser 256 caractères

string (Timestamp format)

Heure de création de l'élément dans le dépôt source.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde près et comportant neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

Heure de la dernière modification de l'élément dans le dépôt source.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde près et comportant neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

object (Interaction)

Liste des interactions pour l'article. Les interactions permettent d'améliorer la qualité de query.search, mais ne sont pas exposées aux utilisateurs finaux. Le nombre d'éléments est limité à 1 000.

string

Code de langue BCP-47 de l'article, tel que "en-US" ou "sr-Latn". Pour en savoir plus, consultez la page http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. La longueur ne doit pas dépasser 32 caractères.

string

Type MIME d'origine de ItemContent.content dans le dépôt source. Ne doit pas dépasser 256 caractères

object (SearchQualityMetadata)

Métadonnées supplémentaires relatives à la qualité de la recherche de l'article

string

Mots clés ou expressions supplémentaires qui doivent correspondre à l'élément. Utilisé en interne pour le contenu généré par l'utilisateur. Le nombre d'éléments est limité à 100. Ne doit pas dépasser 8 192 caractères

string

Valeur de hachage fournie par l'appelant de l'API. Vous pouvez l'utiliser avec la méthode items.push pour calculer l'état modifié. Ne doit pas dépasser 2 048 caractères

object (ContextAttribute)

Ensemble d'attributs nommés associés à l'article. Vous pouvez l'utiliser pour influencer le classement de l'élément en fonction du contexte de la requête. Le nombre d'éléments est limité à 10.

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

enum (Interaction.InteractionType)

object (Principal)

Utilisateur ayant effectué une action sur l'article.

string (Timestamp format)

Date et heure auxquelles l'utilisateur a effectué une action sur l'élément. Si plusieurs actions du même type existent pour un même utilisateur, seule l'action la plus récente est enregistrée.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde près et comportant neuf chiffres décimaux. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

{
  "quality": number
}

number

Indication de la qualité de l'article, utilisée pour influer sur la qualité de la recherche. La valeur doit être comprise entre 0,0 (qualité la plus faible) et 1,0 (qualité la plus élevée). La valeur par défaut est 0.0.

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

string

Nom de l'attribut. Ce champ est obligatoire. La longueur ne doit pas dépasser 32 caractères. Le nom doit commencer par une lettre et ne peut contenir que des lettres (A-Z, a-z) ou des chiffres (0-9). Le nom sera normalisé (en minuscules) avant d'être mis en correspondance.

string

Valeurs textuelles de l'attribut. Le nombre d'éléments est limité à 10. La longueur maximale d'un élément du tableau est de 32 caractères. La valeur sera normalisée (en minuscules) avant d'être mise en correspondance.

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

object (StructuredDataObject)

Objet de données structurées qui doit être conforme à la définition d'un objet enregistré dans le schéma de la source de données.

string

Valeur de hachage fournie par l'appelant de l'API. Vous pouvez l'utiliser avec la méthode items.push pour calculer l'état modifié. Ne doit pas dépasser 2 048 caractères

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

object (NamedProperty)

Propriétés de l'objet. Le nombre d'éléments est limité à 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

Nom de la propriété. Ce nom doit correspondre au nom de la propriété enregistrée pour la définition d'objet dans le schéma. La longueur maximale autorisée pour cette propriété est de 256 caractères.

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)

Horodatage au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde près et comportant neuf chiffres décimaux. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

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

object (StructuredDataObject)

{
  "values": [
    string
  ]
}

string

La longueur maximale autorisée pour les valeurs de chaîne est de 32 caractères.

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

object (Date)

{
  "values": [
    string
  ]
}

string

La longueur maximale autorisée pour les valeurs textuelles est de 2 048 caractères.

{
  "values": [
    string
  ]
}

string

La longueur maximale autorisée pour les valeurs HTML est de 2 048 caractères.

{
  "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

Informations de hachage calculées et fournies par le client API pour le contenu. Peut être utilisé avec la méthode items.push pour calculer l'état modifié. Ne doit pas dépasser 2 048 caractères

string (bytes format)

Contenu fourni avec la méthode "update". La longueur maximale est de 102 400 octets (100 Kio).

Chaîne encodée en base64.

object (UploadItemRef)

Importez l'ID de référence d'un contenu précédemment importé via la méthode d'écriture.

{
  "name": string
}

string

Nom de la référence de contenu. Ne doit pas dépasser 2 048 caractères

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

enum (ItemStatus.Code)

Code d'état.

object (ProcessingError)

Informations sur l'erreur si l'élément est en état ERROR.

object (RepositoryError)

Erreur de dépôt signalée par le connecteur.

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

enum (ProcessingErrorCode)

Code d'erreur indiquant la nature de l'erreur.

string

Description de l'erreur.

object (FieldViolation)

Si les champs de l'élément ne sont pas valides, ce champ contient les détails des erreurs de validation.

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

string

Chemin d'accès du champ ne respectant pas le règlement.

string

Description de l'erreur.

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

enum (RepositoryError.Type)

Type d'erreur.

integer

Codes d'erreur. Correspond à la définition des codes d'état HTTP.

string

Message décrivant l'erreur. La longueur maximale autorisée d'un message est de 8 192 caractères.