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

サンプル

ウェブを検索し、ソースリンクを保存

1つのGoogle検索を実行します。 クエリと使用量と一緒に、結果の順序で一意のソースリンクを保存します。

このページの内容

はじめる前に

google_searchの許可と利用可能なクレジットでキーを使用してください。 Python 3.10+ とリクエスト、Bash と cURL 7.76+ と jq+ を選択します。 Windowsでは、BashパスのGit Bashを使用します。

1. クエリの準備

Web-search フォルダーを作成します。 そこでrequest.jsonを保存し、そのフォルダのターミナルを開きます。 この例では、最大5つの有機結果が要求されます。 1つの新しい実行では、1つの請求可能なクエリを提出します。

web-search/request.json
{
  "source": "google_search",
  "query": "battery recycling research",
  "params": {
    "num": 5
  }
}

2. スクリプトを保存して実行する

1つのバージョンを選択し、request.jsonの横にあるスクリプトを保存します。 FLASHDATA_API_KEY を読み込み、またはキーを表示せずにプロンプトを表示します。 エージェントは、その秘密ストアから環境変数を供給する必要があります。

出力フォルダとしてsearch-001で実行します。 スクリプトは、送信前にリクエストを正確に保存します。 同じフォルダで再び実行すると、保存された応答がAPIを呼び出すことなく読み込まれます。

Python環境にインストール
python -m pip install requests
web-search/search.py
import argparse
import getpass
import json
import os
from datetime import datetime, timezone
from pathlib import Path

import requests

parser = argparse.ArgumentParser()
parser.add_argument("folder", help="New output folder, or an existing saved search")
out = Path(parser.parse_args().folder)

if not out.exists():
    body = Path("request.json").read_bytes()
    request = json.loads(body)
    if not isinstance(request, dict) or request.get("source") != "google_search" or not request.get("query"):
        raise SystemExit("request.json must contain google_search and a query")
    key = os.environ.get("FLASHDATA_API_KEY") or getpass.getpass("FlashData API key: ")
    if not key.strip():
        raise SystemExit("An API key is required")
    out.mkdir()  # A concurrent run cannot submit into the same folder.
    (out / "request.json").write_bytes(body)
    (out / "requested-at.txt").write_text(
        datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ"), encoding="utf-8"
    )
    try:
        response = requests.post(
            "https://data.flashdata.dev/v1/queries/realtime",
            headers={"X-API-Key": key, "Content-Type": "application/json",
                     "Accept": "application/json"},
            data=body, timeout=120, allow_redirects=False,
        )
    except requests.RequestException:
        raise SystemExit(f"Request interrupted. Keep {out} and check History before retrying.")
    (out / "result.json").write_bytes(response.content)
    (out / "response-headers.txt").write_text(
        "\n".join(f"{k}: {v}" for k, v in response.headers.items()), encoding="utf-8"
    )
    (out / "http-status.txt").write_text(str(response.status_code), encoding="utf-8")
else:
    print(f"Reading saved response from {out}; no API call.")

if not (out / "http-status.txt").exists():
    raise SystemExit("Incomplete attempt. Keep the folder and check History before retrying.")
status = (out / "http-status.txt").read_text().strip()
if status != "200":
    raise SystemExit(f"HTTP {status}: inspect {out}/result.json and response-headers.txt")

data = json.loads((out / "result.json").read_bytes())
if not isinstance(data, dict) or data.get("source") != "google_search" or data.get("status") != "done":
    raise SystemExit("Search did not finish successfully; inspect result.json")
pages = data.get("results")
if not isinstance(pages, list) or any(
    not isinstance(page, dict) or not isinstance(page.get("organic"), list) for page in pages
):
    raise SystemExit("Expected results[].organic arrays; inspect result.json")

sources, seen = [], set()
for page in pages:
    for row in page["organic"]:
        if not isinstance(row, dict):
            raise SystemExit("Expected organic result objects; inspect result.json")
        url = row.get("link")
        if isinstance(url, str) and url.strip() and url not in seen:
            seen.add(url)
            sources.append({field: row.get(field) for field in ("title", "link", "snippet")})
record = {
    "request": json.loads((out / "request.json").read_bytes()),
    "requested_at": (out / "requested-at.txt").read_text().strip(),
    "usage": data.get("usage"), "source_count": len(sources), "result_file": "result.json",
}
for filename, value in (("sources.json", sources), ("record.json", record)):
    (out / filename).write_text(json.dumps(value, ensure_ascii=False, indent=2) + "\n", encoding="utf-8")
print(f"Saved {len(sources)} sources to {out}/sources.json")
ウェブ検索から実行する/
python search.py search-001

3. 保存されたソースを読みます

search-001/sources.json.に保存されたNソースを成功プリント 配列は、Google の返された順序で各正確なリンクの最初の発生を保ちます。 使用可能なリンクのない行は省略されます。 欠落したタイトルまたはスニペットの値は、nullのままです。

record.jsonは、送信されたクエリ、リクエスト時間、および返された使用量を含みます。 result.jsonをフル応答として保持します。 これらのファイルを読むことはローカルです。空のソース配列は有効な結果です。

両方のファイルを読む
python -m json.tool search-001/sources.json
python -m json.tool search-001/record.json

出力例

イラスト sources.json; ライブタイトル、リンク、スニペットとカウントは異なります。 回答の証拠としてスニペットを使用する前にリンクされたページを読んでください。

web-search/search-001/sources.json
[
  {
    "title": "Battery recycling research",
    "link": "https://example.org/recycling",
    "snippet": "An example search excerpt."
  }
]

より集中したクエリを試す

ドメインにフォーカスするには、以下の例にrequest.jsonのクエリを変更します。 新規クエリの出力フォルダを選択します。search-001は常に元の保存リクエストを参照します。

web-search/request.json
{
  "source": "google_search",
  "query": "site:energy.gov battery recycling research",
  "params": {
    "num": 5
  }
}
新規問い合わせ・別の請求
python search.py search-002

検索が注意を必要とする場合

何が起こったのか対処方法
401 / 403 / 402それぞれキー、google_searchのパーミッションと残高を確認してください。 この試みを続けてください。新しい出力フォルダを、再度送信する準備が整ったらのみ使用してください。
429response-headers.txt で Retry-After を読み、待ちます。 スクリプトは自動的に再試行しません。
タイムアウト、5xx または不完全なフォルダー保存したファイルを保存し、別の試みを作成する前に History を確認してください。 同じフォルダを再実行すると、新しいリクエストは発生しません。
無効なJSON、失敗した状態または予期しない分野ソースを抽出する前に result.json を調べます。 無効な応答は、空の成功した検索として扱われるべきではありません。
有用な情報源はありません保存されたクエリーを確認します。 より具体的にするか、または過度に狭いフィルターを取除いて下さい、そして別の照会のための新しいホールダーを選んで下さい。

inspect_search.pyをWeb-search/で保存して実行します。

web-search/inspect_search.py
from pathlib import Path

for name in ("http-status.txt", "response-headers.txt", "result.json"):
    path = Path("search-001") / name
    print(f"--- {name} ---")
    print(path.read_text(encoding="utf-8", errors="replace") if path.exists() else "Not saved")
現地で探す
python inspect_search.py