Zum Hauptinhalt springen

Google Search API

Siesta AI - Google Search ermöglicht es, programmgesteuert Web-Suchen über die Google Custom Search JSON API durchzuführen. Die Verbindung ist nur lesend und gibt strukturiertes JSON mit den Ergebnissen zurück.

1. Einrichtung der Google Search API (praktische Anleitung)​

  1. Projekt in Google Cloud: Verwende ein bestehendes oder erstelle ein neues Projekt.
  2. Aktiviere die Custom Search API: Suche in der API-Bibliothek nach "Custom Search API" und klicke auf Aktivieren. Aktivierung der Custom Search API in der API-Bibliothek
  3. Erstelle eine Programmierbare Suchmaschine: Öffne auf https://programmablesearchengine.google.com/ die Liste der Suchmaschinen und klicke auf Hinzufügen. Liste der Suchmaschinen in der Programmierbaren Suchmaschine Erstellung einer neuen Suchmaschine
  4. Erhalte die Suchmaschinen-ID (cx): Öffne im Detail der Suchmaschine den Abschnitt Basis und kopiere die Suchmaschinen-ID. Kopieren der Suchmaschinen-ID (cx)
  5. Generiere einen API-Schlüssel: Gehe zu Google Cloud Console -> APIs & Dienste -> Anmeldedaten -> Anmeldedaten erstellen -> API-Schlüssel. Erstellung des API-Schlüssels in den Anmeldedaten
  6. Einschränkungen des Schlüssels (empfohlen):
    • Anwendungsbeschränkungen: nach Bedarf (Keine/Websites/IP).
    • API-Beschränkungen: Schlüssel einschränken -> Custom Search API.
  7. Einstellungen in Siesta AI:
    • Verbindung -> Verbindung hinzufügen -> GoogleSearch.
    • Fülle Key (API-Schlüssel) und Cx (Suchmaschinen-ID) aus und wähle Geteilt/Privat.
    • Speichere über Weiter. Einstellungen der Verbindung GoogleSearch in Siesta AI

2. Zweck des Dokuments​

Ziel ist es, programmgesteuerten Zugriff auf die Ergebnisse der Websuche über die Google Custom Search JSON API zu ermöglichen.

3. Übersicht der Verbindung​

  • Verbindungsname: GoogleSearch
  • Typ: REST API - Google Custom Search JSON API
  • Authentifizierung: API-Schlüssel (Google Cloud) + Suchmaschinen-ID (cx) (OAuth ist nicht erforderlich)
  • Bereich: nur lesen/suchen
  • Ausgabe: JSON-Objekt mit Suchergebnissen
  • Hinweis: Es gibt keine Schreiboperationen; alle Aufrufe sind idempotent.

Die Google Custom Search JSON API ermöglicht es, programmgesteuert Suchergebnisse von Google über die Programmierbare Suchmaschine zu erhalten, die vor der Verwendung erstellt und konfiguriert werden muss.

4. Allgemeine Prinzipien​

4.1 Konfiguration​

  • Suchmaschinen-ID (cx): Identifikator der eigenen Suchinstanz.
  • API-Schlüssel: Pflichtparameter für autorisierte Aufrufe der Google API.
  • Ausgabe: JSON enthält Metadaten zur Suche und die Ergebnismenge (Titel, Snippet, URL, Pagemap usw.).

4.2 Abfragesyntax​

  • Der Parameter query (Alias q) bestimmt den Suchbegriff.
  • Es können erweiterte Operatoren wie site:, intitle: usw. verwendet werden (Standard-Google-Abfragesyntax).

5. API-Operationen​

5.1 Suche​

Beschreibung: Führt eine Websuche über die Google Custom Search JSON API durch.
HTTP: GET https://www.googleapis.com/customsearch/v1?key={API_KEY}&cx={SEARCH_ENGINE_ID}&q={query}

ParameterTypErforderlichBeschreibung
queryStringJaSuchbegriff (z. B. "AI best practices").

Ausgabe

  • Liste der Ergebnisse (Titel, URL, Snippet)
  • Metadaten zur Anzahl der Ergebnisse
  • Gegebenenfalls weitere Blöcke (pagemap)

Verhalten und Limits

  • Standardantwort ~10 Ergebnisse pro Seite; weitere Seiten über start (außerhalb des Umfangs der Verbindung).

Typische Fehler

  • 400 Bad Request - ungültige Abfrage
  • 401 Unauthorized - ungültiger API-Schlüssel
  • 403 Quota Exceeded - tägliches Kontingent überschritten

6. Sicherheit und Governance​

  • Bewahre den API-Schlüssel sicher auf; bevorzuge Einschränkungen (Domains/IP, Beschränkungen auf die Custom Search API).
  • Überwache Kontingente und protokolliere zur Abrechnungskontrolle.
  • Protokolliere mindestens: query-String, Zeitpunkt des Aufrufs, Anzahl der Ergebnisse, HTTP-Status.

7. Betriebliche Empfehlungen​

  • Setze eine Rotationspolitik für den API-Schlüssel (Schlüssel rotieren in der Google Cloud Console).
  • Halte cx und API-Schlüssel in einem sicheren Secrets-Store; aktualisiere die Verbindung bei Schlüsseländerungen.

8. Beispielverwendung​

GET https://www.googleapis.com/customsearch/v1
  ?key=YOUR_API_KEY
  &cx=YOUR_SEARCH_ENGINE_ID
  &q=cloud+infrastructure+best+practices

Gekürztes JSON:

{
  "queries": { "request": [ { "query": "cloud infrastructure best practices" } ] },
  "items": [
    { "title": "...", "link": "...", "snippet": "..." }
  ]
}