Ga naar de inhoud
NL
API-sleutel ophalen
Documentatie bekijken

Aan de slag

Accountcontroles en opgeslagen resultaten met SDK’s

Controleer de kosten, houd een record van elke poging en lees opgeslagen resultaten zonder een andere API-oproep.

Op deze pagina

Voordat u begint

Gebruik het project, geïnstalleerd SDK en FLASHDATA_API_KEY van uw SDK snelstart. Kies hieronder een taal. Elke nieuwe run directory vertegenwoordigt een beoogde zoekopdracht; het hergebruiken van een bestaande directory stopt voordat u een verzoek doet.

1. Controleer de toegang en de huidige kosten

Bewaar en voer de controle uit voor je SDK. Het leest permissies, balans en de prijs van één Google Search. Uitsluitend doorgaan nadat de toegangscontrole is geslaagd; deze controles leveren geen betaalde vraag of reservekredieten.

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. Uitvoeren met een nieuwe uitvoermap

Voer een van deze programma's na de check pass. Het maakt de map voordat u het indienen, registreert het verzoek, dan slaat het antwoord. Houd de map aan fout: verwijderen of een nieuwe kiezen staat een andere factureerbare query toe.

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

Verwachte bestanden

Succes drukt het opgeslagen resultaat pad en gebruik af. result.json moet status: done hebben; Google resultaten zijn in results[].organic[]. Een lege organische array is geldig. Een gemelde API of transportfout wordt opgeslagen in error.json; intent.json blijft het oorspronkelijke pre-submission record.

Succesvolle poging
runs/research-001/
  request.json # Bron, query en parameters
  intent.json # Poging starttijd
  result.json # Volledige respons, inclusief resultaten en gebruik

3. Opgeslagen uitvoer lezen

Lees result.json voor ontleden, samenvattingen en UI werk. Deze commando's gebruiken alleen lokale bestanden. Het uitvoeren van de zoekopdracht met dezelfde map stopt voordat een netwerkaanroep; het coördineert niet verschillende machines of herstelt een verloren server respons.

Lezen lokaal
cat runs/research-001/result.json

Beslis wat te doen na een fout

Wat je hebtVolgende actie
Bestaande map / EEXISTInspecteer de bestanden. Deze poging heeft geen nieuwe zoekopdracht opgeleverd.
result.json, status: doneLees en verwerk de opgeslagen reactie. Gebruik het als ontvangst van de oorspronkelijke lading.
error.json met 401 / 403 / 402Repareer toegang, bronrechten of balans voordat u een nieuwe poging plant.
429 / retryAfterWacht op de instructies en verlaag de aanvraagsnelheid. Bekijk de mislukte poging voordat u een nieuwe uitvoermap selecteert.
Onbekende inzending / intentie alleen / schrijffoutWerk kan al worden aanvaard. Houd de directory en inspecteer History of een bekende job ID voordat u een andere query verstuurt.

Async-clients en achtergrondjobs

NoodzakelijkGebruik
Houd een event loop responsiefDe async client van de SDK / wacht op oproepen. Een real-time query is nog steeds voltooid in zijn HTTP antwoord.
Hervatten na het aanroepen proces eindigtEen keer een achtergrondtaak indienen, de externe ID opslaan en dan de status en resultaten lezen.
Uitvoeren op een schemaGebruik de eigenaar toegang en duurzame applicatie run records, of de CLI's bestaande run journal.