Method: indexing.datasources.items.index

Met à jour la LCA, les métadonnées et le contenu de Item. Il insère l'Item si elle n'existe pas. Cette méthode n'est pas compatible avec les mises à jour partielles. Les champs pour lesquels aucune valeur n'est fournie sont effacés de l'index Cloud Search.

Pour s'exécuter, cette API nécessite un compte administrateur ou de service. Le compte de service utilisé est celui ajouté à la liste blanche dans 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'article. Format: datasources/{sourceId}/items/{itemId}

Ce champ est obligatoire. La longueur maximale est de 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 de cet élément.
item.metadata

object (ItemMetadata)

Informations des métadonnées.
item.structuredData

object (ItemStructuredData)

Données structurées de l'élément qui doivent respecter une définition d'objet enregistrée dans le schéma de la source de données.
item.content

object (ItemContent)

Contenu de l'élément à indexer et à rendre accessible par recherche de texte.
item.version

string (bytes format)

Obligatoire. Le système d'indexation stocke la version de la source de données sous la forme d'une chaîne d'octets et compare la version de l'article dans l'index à celle de l'article mis en file d'attente à l'aide d'un tri lexical.

L'indexation Cloud Search n'indexe ni ne supprime aucun élément mis en file d'attente dont la 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

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

string (bytes format)

Connecteur d'état supplémentaire pouvant être stocké 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. Paramètre RequestMode de 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 d'autorisation.

IndexItemOptions

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

boolean

Indique si la requête d'index doit autoriser les comptes principaux Google Workspace qui n'existent pas ou qui ont été supprimés.