Cloud Search API

Cloud Search propose des fonctionnalités de recherche dans le cloud sur les données Google Workspace. L'API Cloud Search permet d'indexer les données non 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, utilisez les 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 compatibilité avec 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 indiqué.
searchByViewUrl POST /v1/debug/{name=datasources/*}/items:searchByViewUrl
Récupère l'élément dont "viewUrl" correspond exactement à l'URL fournie dans la requête.

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

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

Ressource REST: v1.debug.identitysources.items

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

Ressource REST: v1.debug.identitysources.unmapids

Méthodes
list GET /v1/debug/{parent=identitysources/*}/unmappedids
Répertorie les identités des utilisateurs 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
Récupère 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/*}
Récupère Item resource par nom d'élément.
index POST /v1/indexing/{item.name=datasources/*/items/*}:index
Met à jour Item la LCA, les métadonnées et le contenu.
list GET /v1/indexing/{name=datasources/*}/items
Répertorie l'ensemble ou un sous-ensemble de Item resources.
poll POST /v1/indexing/{name=datasources/*}/items:poll
Sonde les éléments non réservés de la file d'attente d'indexation et marque un ensemble comme étant réservé, en commençant par les éléments dont l'horodatage est le plus ancien et dont la priorité est la plus élevée (ItemStatus).
push POST /v1/indexing/{item.name=datasources/*/items/*}:push
Un élément est placé dans une file d'attente pour être interrogé et mis à jour ultérieurement.
unreserve POST /v1/indexing/{name=datasources/*}/items:unreserve
Révoque tous les éléments d'une file d'attente, ce qui permet de tous les interroger.
upload POST /v1/indexing/{name=datasources/*/items/*}:upload
Crée une session d'importation pour importer du contenu associé à un élément.

Ressource REST: v1.media

Méthodes
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
Importe du contenu multimédia 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
search POST /v1/query/search
L'API Cloud Query Query propose la méthode de recherche, qui renvoie les résultats les plus pertinents issus 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 de recherche et de suggestion.

Ressource REST: v1.settings

Méthodes
getCustomer GET /v1/settings/customer
Configurez les paramètres du client.
updateCustomer PATCH /v1/settings/customer
Mettez à jour 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.
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
Répertorie toutes les applications de recherche.
reset POST /v1/settings/{name=searchapplications/*}:reset
Rétablit 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
Récupère les statistiques indexées sur les éléments, quelle que soit la source de données.
getQuery GET /v1/stats/query
Obtenez les statistiques de requête pour le client.
getSearchapplication GET /v1/stats/searchapplication
Obtenez des statistiques sur les applications de recherche pour les clients.
getSession GET /v1/stats/session
Obtenez le nombre de sessions de recherche, pourcentage de sessions réussies avec des statistiques sur les requêtes de clic pour le client.
getUser GET /v1/stats/user
Obtenez les statistiques d'interactions utilisateur pour le client.

Ressource REST: v1.stats.index.datasources

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

Ressource REST: v1.stats.query.searchapplications

Méthodes
get GET /v1/stats/query/{name=searchapplications/*}
Obtenez les statistiques de requête de 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, pourcentage de sessions réussies avec une statistique de requête 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 utilisateur relatives à l'application de recherche.