Cloud Search API

Cloud Search fournit des fonctionnalités de recherche dans le cloud pour les données Google Workspace. L'API Cloud Search permet d'indexer des données autres que Google Workspace dans Cloud Search.

Service : cloudsearch.googleapis.com

Pour appeler ce service, nous vous recommandons d'utiliser les bibliothèques clientes fournies par Google. Si votre application doit utiliser vos propres bibliothèques pour appeler ce service, conformez-vous aux informations suivantes lorsque vous effectuez les requêtes API.

Document de découverte

Un document de découverte est une spécification exploitable par un ordinateur qui permet de décrire et de consommer les API REST. Ce document permet de créer des bibliothèques clientes, des plug-ins IDE et d'autres outils qui interagissent avec les API Google. Un même service peut fournir plusieurs documents de découverte. Ce service fournit le document de découverte suivant :

Point de terminaison de service

Un point de terminaison de service est une URL de base qui spécifie l'adresse réseau d'un service d'API. Un service peut posséder plusieurs points de terminaison de service. Ce service possède le point de terminaison de service suivant, et tous les URI ci-dessous sont relatifs à ce point de terminaison de service :

  • https://cloudsearch.googleapis.com

Ressource REST : v1

Méthodes
initializeCustomer POST /v1:initializeCustomer
Active la prise en charge de third party dans Google Cloud Search.

Ressource REST : v1.debug.datasources.items

Méthodes
checkAccess POST /v1/debug/{name=datasources/*/items/*}:checkAccess
Vérifie si un élément est accessible par le compte principal spécifié.
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
Récupère l'élément dont l'URL de vue correspond exactement à celle fournie dans la requête.

Ressource REST : v1.debug.datasources.items.unmappedids

Méthodes
list GET /v1/debug/{parent=datasources/*/items/*}/unmappedids
Liste toutes les identités non mappées pour un article spécifique.

Ressource REST : v1.debug.identitysources.items

Méthodes
listForunmappedidentity GET /v1/debug/{parent=identitysources/*}/items:forunmappedidentity
Liste les noms des éléments associés à une identité non mappée.

Ressource REST : v1.debug.identitysources.unmappedids

Méthodes
list GET /v1/debug/{parent=identitysources/*}/unmappedids
Liste les identités utilisateur non mappées pour une source d'identité.

Ressource REST : v1.indexing.datasources

Méthodes
deleteSchema DELETE /v1/indexing/{name=datasources/*}/schema
Supprime le schéma d'une source de données.
getSchema GET /v1/indexing/{name=datasources/*}/schema
Obtient le schéma d'une source de données.
updateSchema PUT /v1/indexing/{name=datasources/*}/schema
Met à jour le schéma d'une source de données.

Ressource REST : v1.indexing.datasources.items

Méthodes
delete DELETE /v1/indexing/{name=datasources/*/items/*}
Supprime Item resource pour le nom de ressource spécifié.
deleteQueueItems POST /v1/indexing/{name=datasources/*}/items:deleteQueueItems
Supprime tous les éléments d'une file d'attente.
get GET /v1/indexing/{name=datasources/*/items/*}
Obtient Item resource par nom d'élément.
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
Mises à jour Item LCA, métadonnées et contenu.
list GET /v1/indexing/{name=datasources/*}/items
Liste tout ou partie des Item resources.
poll POST /v1/indexing/{name=datasources/*}/items:poll
Interroge la file d'attente d'indexation pour les éléments non réservés et marque un ensemble comme réservé, en commençant par les éléments dont l'horodatage est le plus ancien dans la ItemStatus de priorité la plus élevée.
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
Ajoute un élément à une file d'attente pour une interrogation et une mise à jour ultérieures.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
Annule la réservation de tous les éléments d'une file d'attente, ce qui les rend tous éligibles à l'interrogation.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
Crée une session d'importation pour importer le contenu d'un élément.

Ressource REST : v1.media

Méthodes
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
Importe des contenus multimédias pour l'indexation.

Ressource REST : v1.operations

Méthodes
get GET /v1/{name=operations/**}
Récupère le dernier état d'une opération de longue durée.

Ressource REST : v1.query

Méthodes
removeActivity POST /v1/query:removeActivity
Fournit une fonctionnalité permettant de supprimer l'activité enregistrée d'un utilisateur.
search POST /v1/query/search
L'API Cloud Search Query fournit la méthode de recherche, qui renvoie les résultats les plus pertinents à partir d'une requête utilisateur.
suggest POST /v1/query/suggest
Fournit des suggestions pour la saisie semi-automatique de la requête.

Ressource REST : v1.query.sources

Méthodes
list GET /v1/query/sources
Renvoie la liste des sources que l'utilisateur peut utiliser pour les API Search et Suggest.

Ressource REST : v1.settings

Méthodes
getCustomer GET /v1/settings/customer
Obtenez les paramètres du client.
updateCustomer PATCH /v1/settings/customer
Modifiez les paramètres du client.

Ressource REST : v1.settings.datasources

Méthodes
create POST /v1/settings/datasources
Crée une source de données.
delete DELETE /v1/settings/{name=datasources/*}
Supprime une source de données.
get GET /v1/settings/{name=datasources/*}
Récupère une source de données.
list GET /v1/settings/datasources
Répertorie les sources de données.
patch PATCH /v1/settings/{source.name=datasources/*}
Met à jour une source de données.
update PUT /v1/settings/{source.name=datasources/*}
Met à jour une source de données.

Ressource REST : v1.settings.searchapplications

Méthodes
create POST /v1/settings/searchapplications
Crée une application de recherche.
delete DELETE /v1/settings/{name=searchapplications/*}
Supprime une application de recherche.
get GET /v1/settings/{name=searchapplications/*}
Récupère l'application de recherche spécifiée.
list GET /v1/settings/searchapplications
Liste toutes les applications de recherche.
patch PATCH /v1/settings/{searchApplication.name=searchapplications/*}
Met à jour une application de recherche.
reset POST /v1/settings/{name=searchapplications/*}:reset
Réinitialise les paramètres par défaut d'une application de recherche.
update PUT /v1/settings/{searchApplication.name=searchapplications/*}
Met à jour une application de recherche.

Ressource REST : v1.stats

Méthodes
getIndex GET /v1/stats/index
Obtient les statistiques des éléments indexés agrégées pour toutes les sources de données.
getQuery GET /v1/stats/query
Obtenez les statistiques de requête pour le client.
getSearchapplication GET /v1/stats/searchapplication
Obtenez les statistiques des applications de recherche pour le client.
getSession GET /v1/stats/session
Obtenez le nombre de sessions de recherche, le pourcentage de sessions réussies avec des statistiques de requête de clic pour le client.
getUser GET /v1/stats/user
Obtenez les statistiques des utilisateurs pour le client.

Ressource REST : v1.stats.index.datasources

Méthodes
get GET /v1/stats/index/{name=datasources/*}
Récupère les statistiques des éléments indexés pour une seule source de données.

Ressource REST : v1.stats.query.searchapplications

Méthodes
get GET /v1/stats/query/{name=searchapplications/*}
Obtenez les statistiques de requête pour l'application de recherche.

Ressource REST : v1.stats.session.searchapplications

Méthodes
get GET /v1/stats/session/{name=searchapplications/*}
Obtenez le nombre de sessions de recherche et le pourcentage de sessions ayant abouti avec les statistiques sur les requêtes de clic pour l'application de recherche.

Ressource REST : v1.stats.user.searchapplications

Méthodes
get GET /v1/stats/user/{name=searchapplications/*}
Obtenez les statistiques des utilisateurs pour l'application de recherche.