- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- IndexItemOptions
- Essayer
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 |
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 ( |
Champs | |
---|---|
item.acl |
Liste de contrôle d'accès pour cet élément. |
item.metadata |
Informations sur les métadonnées. |
item.structuredData |
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 |
Contenu des éléments à indexer et à inclure dans l'index de recherche dans le texte |
item.version |
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 |
État de l'article. Champ de sortie uniquement. |
item.queue |
Ajouter cet élément à la file d'attente. La longueur ne doit pas dépasser 100 caractères. |
item.payload |
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 |
Type de cet élément. |
connectorName |
Nom du connecteur effectuant cet appel. Format: datasources/{sourceId}/connectors/{ID} |
mode |
Obligatoire. RequestMode pour cette requête. |
debugOptions |
Options de débogage courantes |
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 |
Indique si la demande d'index doit autoriser les comptes principaux Google Workspace qui n'existent pas ou qui sont supprimés. |