Überspringen zum Inhalt
DE
API-Schlüssel
Dokumentation durchsuchen

Erste Schritte

Kontoprüfungen und gespeicherte Ergebnisse mit SDKs

Überprüfen Sie die Kosten, führen Sie eine Aufzeichnung jedes Versuchs und lesen Sie die gespeicherten Ergebnisse ohne einen weiteren API-Aufruf.

Auf dieser Seite

Bevor Sie anfangen

Verwenden Sie das Projekt, das SDK und FLASHDATA_API_KEY von Ihrem SDK-Schnellstart installiert wurde. Wählen Sie unten eine Sprache aus. Jedes neue ausgeführte Verzeichnis stellt eine beabsichtigte Suche dar; die Wiederverwendung eines vorhandenen Verzeichnisses wird gestoppt, bevor eine Anfrage gestellt wird.

1. Überprüfen Sie den Zugang und aktuelle Kosten

Speichern und führen Sie den Scheck für Ihren SDK aus. Es liest Berechtigungen, Guthaben und den Preis eines Google Search. Fahren Sie erst fort, nachdem der Access-Check bestanden wurde; diese Schecks senden keine bezahlte Abfrage oder Reserveguthaben.

check_access.py
import os
import sys
from flashdata import FlashData, APIError

def main():
    key = os.environ.get("FLASHDATA_API_KEY", "").strip()
    if not key:
        raise RuntimeError("Set FLASHDATA_API_KEY in this terminal.")
    with FlashData(api_key=key) as client:
        access = client.account.access()
        if "google_search" not in access["sources"]:
            raise RuntimeError("This key needs google_search permission.")
        balance = client.account.balance()
        pricing = client.account.pricing(source="google_search", request_count=1)
    price = next((p for p in pricing["prices"]
                  if p["source"] == "google_search" and p["available"]), None)
    cost = price.get("estimatedCredits") if price else None
    if cost is None:
        raise RuntimeError("No current price is available; stop here.")
    available = balance["availableCredits"]
    print(f"Available credits: {available}")
    print(f"One search: {cost} credits")
    if available < cost:
        raise RuntimeError("Insufficient credits. Review Billing.")
    print("Access check passed. No paid query submitted.")

if __name__ == "__main__":
    try:
        main()
    except APIError as error:
        print(f"HTTP {error.status_code}; code={error.code}; "
              f"request_id={error.request_id}; Retry-After={error.retry_after}",
              file=sys.stderr)
        sys.exit(1)
    except Exception as error:
        print(f"{type(error).__name__}: {error}", file=sys.stderr)
        sys.exit(1)
Linux / macOS
.venv/bin/python check_access.py
Windows PowerShell
.\.venv\Scripts\python.exe check_access.py

2. Führen Sie mit einem neuen Ausgabeverzeichnis

Führen Sie eines dieser Programme aus, nachdem der Scheck bestanden wurde. Es erstellt das Verzeichnis vor dem Absenden, zeichnet die Anfrage auf und speichert dann die Antwort. Behalten Sie das Verzeichnis auf Fehler: Das Löschen oder Auswählen eines neuen Verzeichnisses ermöglicht eine weitere abrechenbare Abfrage.

archive_search.py
import json
import os
import sys
from datetime import datetime, timezone
from pathlib import Path
from flashdata import FlashData, APIError, SubmissionUnknownError

def main():
    key = os.environ.get("FLASHDATA_API_KEY", "").strip()
    if not key:
        raise RuntimeError("Set FLASHDATA_API_KEY before running.")
    directory = Path(sys.argv[1] if len(sys.argv) > 1 else "runs/research-001")
    directory.mkdir(mode=0o700, parents=True, exist_ok=False)

    def save(name, value):
        with (directory / name).open("x", encoding="utf-8") as output:
            json.dump(value, output, ensure_ascii=False, indent=2)

    request = {"source": "google_search", "query": "battery recycling research",
               "params": {"num": 5}}
    save("request.json", request)
    save("intent.json", {"state": "dispatching",
                         "startedAt": datetime.now(timezone.utc).isoformat()})
    try:
        with FlashData(api_key=key) as client:
            response = client.google.search(request["query"], **request["params"])
    except (APIError, SubmissionUnknownError) as error:
        detail = {"kind": type(error).__name__}
        if isinstance(error, APIError):
            detail.update(code=error.code, httpStatus=error.status_code,
                          requestId=error.request_id, retryAfter=error.retry_after)
        save("error.json", detail)
        raise RuntimeError("Inspect the saved attempt and History before retrying.") from None
    save("result.json", response)
    if response.get("status") != "done":
        raise RuntimeError("Response saved; inspect its status before proceeding.")
    print("Saved:", directory / "result.json")
    print("Usage:", response.get("usage"))

if __name__ == "__main__":
    try:
        main()
    except Exception as error:
        print(f"{type(error).__name__}: {error}", file=sys.stderr)
        sys.exit(1)
Linux / macOS
.venv/bin/python archive_search.py runs/research-001
Windows PowerShell
.\.venv\Scripts\python.exe archive_search.py runs/research-001

Voraussichtliche Dateien

Erfolg druckt den gespeicherten Ergebnispfad und die Nutzung. result.json sollte status: done haben; Google Ergebnisse sind in results[].organic[]. Eine leere organische Anordnung ist gültig. Ein gemeldeter API- oder Transportfehler wird in error.json gespeichert; intent.json bleibt der ursprüngliche Voreinreichungs-Datensatz.

Erfolgreicher Versuch
runs/research-001/
  request.json # Quelle, Abfrage und Parameter
  intent.json # Startzeit versuchen
  result.json # Vollständige Antwort, einschließlich Ergebnisse und Nutzung

3. Gespeicherte Ausgabe lesen

Lesen Sie result.json für Parsing, Zusammenfassungen und UI-Arbeit. Diese Befehle verwenden nur lokale Dateien. Das erneute Ausführen der Suche mit demselben Verzeichnis wird vor einem Netzwerkaufruf gestoppt; es koordiniert nicht verschiedene Computer oder stellt eine verlorene Serverantwort wieder her.

Vor Ort lesen
cat runs/research-001/result.json

Entscheiden Sie, was nach einem Misserfolg zu tun ist

Was du hastNächste Maßnahme
Bestehendes Verzeichnis / EEXISTInspizieren Sie seine Akten. Es wurde keine neue Abfrage durch diesen Versuch gesendet.
result.json, status: doneLesen und Verarbeiten der gespeicherten Antwort. Wiederverwendung seiner Verwendung als Erhalt der ursprünglichen Gebühr.
error.json mit 401 / 403 / 402Beheben Sie Zugriff, Quellberechtigungen oder Balance, bevor Sie einen neuen Versuch planen.
429 / retryAfterWarten Sie wie angewiesen und reduzieren Sie die Anforderungsrate. Überprüfen Sie den fehlgeschlagenen Versuch, bevor Sie ein neues Run-Verzeichnis auswählen.
Unbekannte Einreichung / Absicht nur / SchreibfehlerArbeiten können bereits angenommen werden. Führen Sie das Verzeichnis und prüfen Sie History oder einen bekannten Job ID, bevor Sie eine weitere Abfrage senden.

Async-Clients und Hintergrundjobs

BedarfVerwendung
Halten Sie eine Ereignisschleife reaktionsschnellDer async-Client / await-Aufrufe des SDK. Eine Echtzeitabfrage wird in ihrer HTTP-Antwort noch abgeschlossen.
Wiederaufnahme nach dem Aufrufen Prozess beendetSenden Sie einmal einen Hintergrundjob, speichern Sie den entfernten ID, lesen Sie dann Status und Ergebnisse.
Laufen Sie nach einem ZeitplanVerwenden Sie den Besitzerzugriff und dauerhafte Anwendungslaufdatensätze oder das bestehende Laufjournal des CLI.