コンテンツへスキップ
JA
APIキーを取得する
ドキュメントを探す

はじめに

SDK でのアカウント確認と保存済み結果

コストをチェックし、各試みの記録を保持し、別のAPIコールなしで保存された結果を読み続ける。

このページの内容

はじめる前に

SDKクイックスタートからSDKとFLASHDATA_API_KEYをインストールしてインストールします。 下記のいずれかの言語を選択します。 それぞれの新しい実行ディレクトリは、意図した検索を表します。既存のディレクトリを再利用して、リクエストをする前に停止します。

1. アクセスと現在のコストをチェック

SDKのチェックを保存して実行します。 Google Searchの許可、残高、価格を読みます。 アクセスチェックが渡された後だけ続行してください。これらのチェックは、有料のクエリや予約クレジットを提出しません。

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. 新しい出力ディレクトリで実行する

チェックパスの後に、これらのプログラムの1つを実行します。 送信する前にディレクトリを作成し、リクエストを記録し、応答を保存します。 ディレクトリを失敗に保ちます:削除するか、新しいものを選択すると、別の課金クエリが許可されます。

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

期待されるファイル

成功は保存された結果パスおよび使用法を印刷します。 result.jsonはstatus: doneを持っているべきです; Google 結果は results[].organic[] です。 空の有機配列が有効です。 API または輸送エラーが error.json に保存されていると報告した。 intent.json は、元の事前許可記録を保持します。

成功の試み
runs/research-001/
  request.json # ソース、クエリ、パラメータ
  intent.json # スタートタイムを試みる
  result.json # 結果と使用を含む完全な応答、

3. 保存された出力を読んで下さい

解析、要約、UI 作業の result.json をお読みください。 これらのコマンドはローカルファイルのみを使用します。 同じディレクトリで検索を実行すると、ネットワークコールの前に停止します。異なるマシンを調整したり、失われたサーバー応答を回復したりしません。

ローカルで読む
cat runs/research-001/result.json

故障後に何をすべきかを決める

あなたが持っているもの次のアクション
既存のディレクトリ/EEXISTファイルを調べます。 この試みで新しいクエリが送信されなかった。
result.json、status: done保存された応答を読み、処理します。 元の料金の領収書として使用を再利用します。
error.json とりあえず 401 / 403 / 402新規の試みを計画する前にアクセス、ソースの権限、残高を修正します。
429 / retryAfterリクエスト率を指示し、削減するように待ってください。 新しい実行ディレクトリを選択する前に、失敗した試みを確認します。
未知の投稿/意図のみ/書き込みの失敗既に受付けます。 ディレクトリを保ち、別のクエリを送信する前に、History または既知のジョブ ID を検査します。

Asyncクライアントと背景ジョブ

お問い合わせ利用条件
イベント ループを応答させるSDKの非同期クライアント/待ち合わせ呼び出し。 HTTP 応答でリアルタイムのクエリがまだ完了します。
呼び出しプロセス終了後の再開背景ジョブを一度送信し、リモートIDを保存し、ステータスと結果を読みます。
スケジュールで実行する所有者のアクセスと耐久性のあるアプリケーション実行レコード、またはCLIの既存の実行ジャーナルを使用します。