Method: indexing.datasources.items.index

Met à jour la LCA, les métadonnées et le contenu Item. Le Item sera inséré s'il n'existe pas. Cette méthode n'est pas compatible avec les mises à jour partielles. Les champs sans valeur fournie sont effacés de l'index Cloud Search.

L'exécution de cette API nécessite un compte administrateur ou de service. Le compte de service utilisé est celui qui figure sur la liste blanche de la source de données correspondante.

Requête HTTP

POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
item.name

string

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

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

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "item": {
    "name": string,
    "acl": {
      "inheritAclFrom": string,
      "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
      "readers": [
        {
          object (Principal)
        }
      ],
      "deniedReaders": [
        {
          object (Principal)
        }
      ],
      "owners": [
        {
          object (Principal)
        }
      ]
    },
    "metadata": {
      "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)
        }
      ]
    },
    "structuredData": {
      "object": {
        object (StructuredDataObject)
      },
      "hash": string
    },
    "content": {
      "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.
    },
    "version": string,
    "status": {
      "code": enum (ItemStatus.Code),
      "processingErrors": [
        {
          object (ProcessingError)
        }
      ],
      "repositoryErrors": [
        {
          object (RepositoryError)
        }
      ]
    },
    "queue": string,
    "payload": string,
    "itemType": enum (Item.ItemType)
  },
  "connectorName": string,
  "mode": enum (RequestMode.Mode),
  "debugOptions": {
    object (DebugOptions)
  },
  "indexItemOptions": {
    object (IndexItemOptions)
  }
}
Champs
item.acl

object (ItemAcl)

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

object (ItemMetadata)

Informations sur les métadonnées.
item.structuredData

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.
item.content

object (ItemContent)

Contenu des éléments à indexer et à inclure dans l'index de recherche dans le texte
item.version

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 à 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 une suppression manuelle.

Chaîne encodée en base64.
item.status

object (ItemStatus)

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

string

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

string (bytes format)

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

Chaîne encodée en base64.
item.itemType

enum (Item.ItemType)

Type de cet élément.
connectorName

string

Nom du connecteur effectuant cet appel.

Format: datasources/{sourceId}/connectors/{ID}
mode

enum (RequestMode.Mode)

Obligatoire. RequestMode pour cette requête.
debugOptions

object (DebugOptions)

Options de débogage courantes
indexItemOptions

object (IndexItemOptions)

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

Pour en savoir plus, consultez le guide relatif aux autorisations.

IndexItemOptions

Représentation JSON 
{
  "allowUnknownGsuitePrincipals": boolean
}
Champs
allowUnknownGsuitePrincipals

boolean

Indique si la demande d'index doit autoriser les comptes principaux Google Workspace qui n'existent pas ou qui sont supprimés.