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'élément. Format: datasources/{sourceId}/items/{itemId}

Ce champ est obligatoire. La longueur maximale est de 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 devant être conformes à une définition d'objet enregistré dans le schéma de la source de données.

object (ItemContent)

Contenu de l'élément à indexer et à inclure dans le texte de l'index de recherche.

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 dans l'index à celle de l'élément en file d'attente en utilisant l'ordre lexical.

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

Pour en savoir plus sur l'impact des versions d'éléments sur le processus de suppression, consultez Gérer les révisions après des suppressions manuelles.

Chaîne encodée en base64.

object (ItemStatus)

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

string

Ajoutez cet élément à la file d'attente. La longueur ne doit pas dépasser 100 caractères.

string (bytes format)

Un connecteur d'état supplémentaire peut être stocké pour 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 il doit hériter la liste d'autorisations d'accès (LCA). Remarque: L'héritage des LCA uniquement fournit des autorisations d'accès aux éléments enfants. Il ne définit pas de relations structurelles ni ne fournit de moyens pratiques de supprimer de grands groupes d'éléments. La suppression d'un parent 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 peut ne pas être visible dans les résultats de recherche. En revanche, la suppression d'un élément conteneur entraîne également la suppression de tous les éléments qui font référence au conteneur 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 sa LCA d'un élément parent. Vous devez toujours le définir en même temps que le champ inheritAclFrom. De plus, lorsque le champ inheritAclFrom est défini, il doit être défini sur un 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 destiné à être visible (par exemple, virtual containers). Le nombre maximal d'éléments est de 1 000.

object (Principal)

Liste des comptes principaux explicitement refusés d'accéder à l'élément dans les résultats de recherche. Bien que l'accès soit refusé par défaut aux comptes principaux, utilisez les lecteurs refusés pour gérer les exceptions et ignorer la liste des lecteurs autorisés. Le nombre maximal d'éléments est de 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. Cependant, il offre un léger classement favorise les éléments dont l'utilisateur à l'origine de la requête est propriétaire. Le nombre d'éléments est limité à 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 est 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: identitésources/{sourceId}/users/{ID}

string

Ce compte principal est un groupe identifié à l'aide d'une identité externe. Le champ "name" doit spécifier le nom de la ressource du groupe au format suivant: identitésources/{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'élément. Si cet argument est indiqué, il s'agit du titre affiché du résultat query.search. La longueur maximale est de 2 048 caractères.

string

Lien vers le dépôt source qui diffuse les données. Les résultats de recherche appliquent ce lien au titre. Les espaces ou les caractères spéciaux peuvent déclencher une notification de redirection via les liens dans les résultats Cloud Search. pour éviter cela, encodez l'URL. La longueur maximale est de 2 048 caractères.

string

Nom du conteneur de cet élément. Si vous supprimez l'élément conteneur, il sera automatiquement supprimé. Remarque: Les LCA ne sont pas héritées d'un élément de conteneur. Pour fournir l'héritage des LCA pour un élément, utilisez le champ inheritAclFrom. La longueur maximale est de 1 536 caractères.

string

Type d'élément. Il 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 demandes d'indexation d'objets de ce type doivent définir "objectType" sur "document". La longueur maximale est de 256 caractères.

string (Timestamp format)

Heure à laquelle l'élément a été créé dans le dépôt source.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à 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 de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

object (Interaction)

Liste des interactions pour l'élément. Les interactions sont utilisées pour améliorer la qualité de query.search, mais elles ne sont pas visibles par les utilisateurs finaux. Le nombre maximal d'éléments est de 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. La longueur maximale est de 256 caractères.

object (SearchQualityMetadata)

Métadonnées supplémentaires sur la qualité de la recherche de l'élément

string

Mots clés ou expressions supplémentaires qui doivent correspondre à l'élément. Utilisé en interne pour les contenus générés par les utilisateurs. Le nombre maximal d'éléments est de 100. La longueur maximale est de 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é. La longueur maximale est de 2 048 caractères.

object (ContextAttribute)

Ensemble d'attributs nommés associés à l'article. Cela peut être utilisé pour influencer le classement de l'élément en fonction du contexte de la demande. Le nombre maximal d'éléments est de 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)

Heure à laquelle l'utilisateur a effectué une action sur l'élément. S'il existe plusieurs actions du même type 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 de l'ordre de la nanoseconde et jusqu'à 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'élément, utilisée pour influencer la qualité de la recherche. doit être comprise entre 0 (qualité la plus faible) et 1 (qualité la plus élevée). La valeur par défaut est 0.0.

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

string

Nom de l'attribut. Ce champ ne doit pas être vide. 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 est normalisé (en minuscules) avant d'être mis en correspondance.

string

Valeurs textuelles de l'attribut. Le nombre maximal d'éléments est de 10. La longueur maximale d'un élément du tableau est de 32 caractères. La valeur est 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 à une définition d'objet enregistrée 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é. La longueur maximale est de 2 048 caractères.

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

object (NamedProperty)

Propriétés de l'objet. Le nombre maximal d'éléments est de 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 à celui 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 de l'ordre de la nanoseconde et jusqu'à 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 de texte 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é. La longueur maximale est de 2 048 caractères.

string (bytes format)

Contenu fourni intégré dans la méthode de mise à jour. 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 déjà mis en ligne en utilisant la méthode d'écriture.

{
  "name": string
}

string

Nom de la référence de contenu. La longueur maximale est de 2 048 caractères.

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

enum (ItemStatus.Code)

Code d'état.

object (ProcessingError)

Détails de l'erreur au cas où l'élément serait à l'état ERREUR.

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'article ne sont pas valides, ce champ contient des informations sur les erreurs de validation.

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

string

Chemin d'accès du champ présentant une violation.

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 pour le message est de 8 192 caractères.