In diesem Dokument erfahren Sie mehr über die Custom Search JSON API und ihre Verwendung.
Vorbereitung
Programmable Search Engine erstellen
Durch den Aufruf der API werden Anfragen an eine vorhandene Instanz der Programmable Search Engine gesendet. Bevor Sie die API verwenden können, müssen Sie daher ein Konto in der Systemsteuerung erstellen . Im Tutorial finden Sie weitere Informationen zu den verschiedenen Konfigurationsoptionen. Nachdem Sie die Programmable Search Engine erstellt haben, finden Sie die Suchmaschinen-ID auf der Seite Übersicht im Bereich Basisdaten. Dies ist der Parameter cx, der von der API verwendet wird.
Anwendung mit API-Schlüssel bei Google identifizieren
Für die Custom Search JSON API ist ein API-Schlüssel erforderlich. Mit einem API-Schlüssel können Sie Ihren Client gegenüber Google identifizieren.
Nachdem Sie einen API-Schlüssel haben, kann Ihre Anwendung den Suchparameter key=yourAPIKey an alle Anfrage-URLs anhängen. Der API-Schlüssel lässt sich sicher in URLs einbetten. Eine Codierung ist nicht notwendig.
API-Übersicht
API-Vorgänge
In der Custom Search JSON API gibt es nur eine Methode, die aufgerufen werden kann:
| Vorgang | Beschreibung | REST-HTTP-Zuordnung |
|---|---|---|
| list | Gibt die angeforderten Suchergebnisse einer Programmable Search Engine zurück. | GET |
API-Datenmodell
Das Ergebnis einer Suchanfrage an die Custom Search JSON API ist ein JSON-Objekt, das drei Arten von Daten enthält:
- Metadaten, die die angeforderte Suche (und möglicherweise ähnliche Suchanfragen) beschreiben
- Metadaten, die die Programmable Search Engine beschreiben
- Suchergebnisse
Weitere Informationen finden Sie im Abschnitt „Antwortdaten“ unter REST verwenden.
Das Datenmodell basiert auf der OpenSearch 1.1-Spezifikation. Zusätzlich zu den OpenSearch-Standardattributen werden in der Custom Search JSON API zwei benutzerdefinierte Attribute und zwei benutzerdefinierte Abfragerollen definiert:
- Benutzerdefinierte Eigenschaften
cx: Die Kennung der Programmable Search Engine.safe: Eine Beschreibung der Stufe der sicheren Suche zum Filtern der zurückgegebenen Ergebnisse.
- Benutzerdefinierte Abfragerollen
nextPage: Eine Rolle, die angibt, dass mit der Abfrage auf die nächste logische Seite mit Ergebnissen zugegriffen werden kann, sofern vorhanden.previousPage: Eine Rolle, die angibt, dass mit der Abfrage auf die vorherige logische Seite mit Ergebnissen zugegriffen werden kann, sofern vorhanden.
Jetzt ausprobieren
Wenn Sie sich mit der API vertraut machen möchten, ohne Code zu schreiben, rufen Sie das Tool „Diese API testen“ auf.
Eine vollständige Beschreibung der Parameter finden Sie in der cse.list-Referenz.
Informationen zur Verwendung der API über HTTP-Anfragen finden Sie unter REST verwenden.