Ce document vous aidera à vous familiariser avec l'API JSON Custom Search et son utilisation.
Avant de commencer
Créer un moteur Programmable Search Engine
En appelant l'API, l'utilisateur envoie des requêtes à une instance existante du moteur de recherche programmable. Par conséquent, avant d'utiliser l'API, vous devez en créer une dans le panneau de configuration . Suivez le tutoriel pour en savoir plus sur les différentes options de configuration. Une fois créé, l'ID du moteur de recherche se trouve dans la section Basique de la page Présentation. Il s'agit du paramètre cx utilisé par l'API.
Identifier votre application auprès de Google avec une clé API
L'API JSON Custom Search nécessite l'utilisation d'une clé API. Une clé API permet d'identifier votre client auprès de Google.
Une fois la clé API obtenue, votre application peut ajouter le paramètre de requête key=yourAPIKey à toutes les URL de requête. La clé API peut s'intégrer aux URL en toute sécurité et ne nécessite pas d'encodage.
Présentation de l'API
Opérations d'API
Il n'existe qu'une seule méthode à appeler dans l'API JSON Custom Search :
| Opération | Description | Mappage HTTP REST |
|---|---|---|
| liste | Renvoie les résultats de recherche demandés à partir d'un moteur de recherche programmable. | GET |
Modèle de données de l'API
Le résultat d'une requête de recherche envoyée à l'API JSON Custom Search est un objet JSON qui inclut trois types de données :
- Métadonnées décrivant la recherche demandée (et éventuellement les requêtes de recherche associées)
- Métadonnées décrivant le moteur Programmable Search Engine
- Résultats de recherche
Pour en savoir plus, consultez la section "Données de réponse" de la page Utiliser REST.
Le modèle de données est basé sur la spécification OpenSearch 1.1. En plus des propriétés OpenSearch standards, l'API JSON Custom Search définit deux propriétés personnalisées et deux rôles de requête personnalisés :
- Propriétés personnalisées
cx: identifiant de Programmable Search Engine.safe: description du niveau de recherche sécurisée pour filtrer les résultats renvoyés.
- Rôles de requête personnalisés
nextPage: rôle qui indique que la requête peut être utilisée pour accéder à la page logique suivante des résultats, le cas échéant.previousPage: rôle qui indique que la requête peut être utilisée pour accéder à la page logique précédente des résultats, le cas échéant.
Essayer
Pour tâter le terrain et découvrir ce qu'il est possible de faire avec l'API sans écrire la moindre ligne de code, consultez l'outil "Essayer cette API".
Pour obtenir une description complète des paramètres, consultez la documentation de référence cse.list.
Pour savoir comment utiliser l'API via des requêtes HTTP, consultez Utiliser REST.