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

はじめに

Python SDKクイックスタート

Python SDKをインストールし、いくつかの行のコードで検索結果を印刷します。 同期と非同期の例が含まれています。

  1. SDKをインストール

    Python 3.10+を要求して下さい。 プロジェクトディレクトリでこれらのコマンドを実行します。 仮想環境で既に利用されているの? その環境の python -m pip で flashdata===1.1.0 をインストールします。

    インストール
    python3 -m venv .venv
    .venv/bin/python -m pip install "flashdata==1.1.0"
  2. 認証

    Google Search 権限で API キーを作成、または承認されたキーを再使用して下さい。 以下に隠れたプロンプトを使用して、このターミナルで設定します。

    FLASHDATA_API_KEYが既に設定されている場合は、プロンプトをスキップします。 これらの例は、変数を直接読み込みます。 .env ファイルが読み込まれません。

    隠しキープロンプト・Bash
    # Bash: paste the key into a hidden prompt, not into this command.
    read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
    printf '\n'
    export FLASHDATA_API_KEY
  3. 検索を実行

    これをquickstart.pyとして保存し、同じ仮想環境で実行します。 Google Search は、URLs とクレジットの5つの結果とプリントのタイトルを最大 5つの結果のリクエストに1つ作成します。

    quickstart.py
    import os
    from flashdata import FlashData
    
    with FlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client:
        response = client.google.search("battery recycling research", num=5)
        if response["status"] != "done":
            raise RuntimeError(response)
        for page in response["results"]:
            for hit in page.get("organic", []):
                print(hit["title"], hit["link"])
        print("Credits used:", response["usage"]["credits"])
    実行
    .venv/bin/python quickstart.py
  4. 結果を確認

    ステータスの確認後、スクリプトが正常に終了します。 ソースのタイトルとURLsを期待して、使用したクレジットが続きます。 空のオーガニックリストは有効な応答です。結果はクエリによって異なります。

    出力例
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Google Search がヒット: タイトル, リンクとスニペット. 他のソースには異なる結果フィールドがあります。
    usage.credits
    このリクエストのコスト。 結果は最大5件までを一括検索できます。

別のデータソースを試す

各タブは完全なスクリプトです。 リプレース quickstart.py 1つの例で、ステップからコマンドで実行します。 3. 各実行は、新しいリクエストを1つ提出します。キーは、ソースの権限が示されている必要があります。

google_newsが必要です。 results[].news[]から記事のタイトルとソースリンクを印刷します。

quickstart.py
import os
from flashdata import FlashData

with FlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client:
    response = client.google.news("battery recycling", num=5)
    if response["status"] != "done":
        raise RuntimeError(response)
    for page in response["results"]:
        for article in page.get("news", []):
            print(article.get("title"), article.get("link"))

Python SDKサポートとは

google / youtube
Google Search、ニュース、画像、ショッピング、ビデオ、場所。 YouTubeの発見、メタデータ、キャプション、トランスクリプト、チャネルデータ。
youtube.download
クラウドストレージにオーディオまたはビデオ配信ジョブを送信します。 youtube_downloadの許可と保存設定が必要です。以下の完全なダウンロード例に従ってください。
jobs / bulk
ID のジョブを保存し、完了を待ち、結果を取り出します。 より大きなビデオ-IDデータセットに一括して、再起動後に既存のジョブを再開します。
account
作業を繰り返しる前にアクセス、残高、価格設定、制限、使用量をお読みください。 環境や秘密ストアから認証されたキーを再利用します。
respond_with / accept
利用条件 respond_with="markdown" のための Markdown 応答で["content"], または 受け入れ ="text/plain" 文字列の場合。 JSON辞書はデフォルトです。

asyncio を使う

このバージョンでquickstart.pyを置換し、同じ実行コマンドを使用します。 AsyncFlashData は、同じリソースを待っています。 リアルタイム検索応答を待ちます。mode="async"はサーバー側のバックグラウンドジョブを代わりに送信します。

Jupyter または実行中のイベントループを持つアプリケーションでは、asyncio.run(main() の代わりに main() を待っています。 そのイベントループ内でクライアントを再利用します。

quickstart.py
import asyncio
import os
from flashdata import AsyncFlashData

async def main():
    async with AsyncFlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client:
        response = await client.google.search("battery recycling research", num=5)
        if response["status"] != "done":
            raise RuntimeError(response)
        for page in response["results"]:
            for hit in page.get("organic", []):
                print(hit["title"], hit["link"])
        print("Credits used:", response["usage"]["credits"])

asyncio.run(main())

次のステップ

ステップが失敗した場合

ModuleNotFoundError
.venv/bin/python -m pip show flashdata (Windows: .\.venv\Scripts\python.exe -m pip show flashdata) をインストールして実行します。 スクリプトのflashdata.pyを名前付けないでください。
KeyError: FLASHDATA_API_KEY / 401
同じターミナルでアクティブな API キーを設定します。 .env ファイルだけでは、この例では読み込まれません。 APIキーではなく、MCP OAuthトークンを使用します。
403
このキーに例を要するソースの許可を付与します。
402
利用可能なクレジットについては、Billingをチェックしてください。 トライアルアクセスが疲れている場合は、アカウント残高を使用する接続を要求します。
429 / APIError
error.retry_afterを点検し、要求率を減らして下さい。 SDKは、一度に各リクエストを送信し、自動的に再試行しません。
SubmissionUnknownError
期限切れの投稿は既に受付けます。 Historyを繰り返す前にチェックします。 保存されたジョブを再利用します。 ID 利用可能な場合。
asyncio.run() / running event loop
ノートブックや既存のイベントループで main() を待ってください。 asyncio.run(main()) をスタンドアローンスクリプトに保ちます。