ドキュメントを探す
はじめに
最初の Google 検索を実行し、アプリや AI エージェント用の構造化された結果を取得します。
AI エージェントで始める
ターミナルにアクセスできるエージェントにこのプロンプトを渡してください。FlashData を設定し、検索を 1 回実行します。
https://flashdata.dev/auth.md を読み、この環境向けの FlashData 設定手順に従ってください。既存のアクセスを再利用し、存在しない場合だけ、条件を満たす試用を1回開始してください。Google で "battery recycling research" を検索し、最大5件の結果を取得してください。ソースのタイトル、URL、実際に使用したクレジットを返してください。認証情報は保護されたストレージに保存し、チャットには出さないでください。アクセスがブロックされた場合は、新たな試用を作らず、次に必要な手順を報告してください。
最初の API 呼び出し
自分でコードを書きたい場合は、ターミナルで次の 3 ステップを実行してください。
API キーを取得する
アカウントを作成してメールアドレスを確認し、Google Search 権限のあるキーを作成します。既存のキーがあれば再利用できます。
ターミナルで実行し、入力内容が表示されないプロンプトにキーを貼り付けます。FLASHDATA_API_KEY が設定済みなら、この手順は不要です。
キーを設定# 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キーを設定# PowerShell 7: paste the key into a hidden prompt. $flashdataSecureKey = Read-Host "FlashData API key" -AsSecureString $env:FLASHDATA_API_KEY = [System.Net.NetworkCredential]::new("", $flashdataSecureKey).Password Remove-Variable flashdataSecureKey検索を実行
言語を選び、同じターミナルでサンプルを実行します。実行するたびに検索が 1 回送信されます。
Python 3.10+ · サンプルを quickstart.py として保存します。
インストールpython -m pip install "flashdata==1.1.0"quickstart.pyimport json 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) print(json.dumps(response, indent=2))実行python quickstart.pyNode.js 22.18+ · 空のフォルダーで開始し、quickstart.mts を保存します。
セットアップnpm init -y npm install --save-exact @flashdata-dev/[email protected]quickstart.mtsimport { FlashData } from '@flashdata-dev/sdk'; const apiKey = process.env.FLASHDATA_API_KEY; if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.'); const client = new FlashData({ apiKey }); const response = await client.google.search({ query: 'battery recycling research', num: 5, }); if (response.status !== 'done') throw new Error(JSON.stringify(response)); console.log(JSON.stringify(response, null, 2));実行node quickstart.mtsNode.js 22+ · 空のフォルダーで開始し、quickstart.mjs を保存します。
セットアップnpm init -y npm install --save-exact @flashdata-dev/[email protected]quickstart.mjsimport { FlashData } from '@flashdata-dev/sdk'; const apiKey = process.env.FLASHDATA_API_KEY; if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.'); const client = new FlashData({ apiKey }); const response = await client.google.search({ query: 'battery recycling research', num: 5, }); if (response.status !== 'done') throw new Error(JSON.stringify(response)); console.log(JSON.stringify(response, null, 2));実行node quickstart.mjsGo 1.25+ · 空のフォルダーで開始し、main.go を保存します。既存のモジュールでは go mod init を省略します。
セットアップgo mod init example.com/flashdata-quickstart go get github.com/flashdatadev/[email protected]main.gopackage main import ( "context" "encoding/json" "log" "os" "time" flashdata "github.com/flashdatadev/flashdata-go" ) func main() { key := os.Getenv("FLASHDATA_API_KEY") if key == "" { log.Fatal("Set FLASHDATA_API_KEY through your server's secret manager.") } client, err := flashdata.New(flashdata.Options{APIKey: key}) if err != nil { log.Fatal(err) } ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute) defer cancel() result, err := client.Google.Search(ctx, flashdata.GoogleSearchInput{ Query: "battery recycling research", Params: &flashdata.GoogleSearchParams{Num: flashdata.Ptr(int64(5))}, }) if err != nil { // Do not automatically resubmit an uncertain paid request. log.Fatal(err) } if err := json.NewEncoder(os.Stdout).Encode(result); err != nil { log.Fatal(err) } if result.Status != "done" { log.Fatalf("Search did not complete: %s", result.Status) } }実行go run .SDK は不要です。Bash / cURL 7.76+ または PowerShell 7 のいずれかのコマンドを実行します。
Bash / cURLcurl --fail-with-body --silent --show-error \ --request POST https://data.flashdata.dev/v1/queries/realtime \ --header "X-API-Key: $FLASHDATA_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"source":"google_search","query":"battery recycling research","params":{"num":5}}'PowerShell 7$flashdataRequest = '{"source":"google_search","query":"battery recycling research","params":{"num":5}}' $flashdataResult = Invoke-RestMethod -Method Post -Uri 'https://data.flashdata.dev/v1/queries/realtime' -Headers @{ 'X-API-Key' = $env:FLASHDATA_API_KEY } -ContentType 'application/json' -Body $flashdataRequest $flashdataResult | ConvertTo-Json -Depth 20結果を確認
成功したレスポンスには status: done が含まれます。ソースは results[].organic、消費クレジットは usage.credits で確認できます。
レスポンスの例(抜粋){ "status": "done", "results": [ { "organic": [ { "title": "Battery recycling research", "link": "https://example.org/recycling", "snippet": "An example search excerpt." } ] } ], "usage": { "credits": 0.02 } }
コンソールで試す
- アカウントを作成するかログインし、メールアドレスの確認とコンソールに表示される設定を完了します。
- Google Search を開き、ソースに Google Search、モードに Realtime を選び、battery recycling research を入力します。Additional parameters を開き、Page size (num) を 5 に設定します。
- 表示されたリクエストと残高を確認し、検索を 1 回実行します。
- レスポンスと使用量を確認します。抜粋より詳しい内容を引用する前に、返されたソースを開いて内容を確認してください。
最初の結果から先へ進む
最初のリクエストが失敗した場合
- FLASHDATA_API_KEY がない
- サンプルと同じターミナルまたは実行環境でキーを設定します。これらのコード例は .env ファイルを読み込みません。
- 401 / 403
- キーまたは接続が有効で、google_search 権限があることを確認します。
- 402
- Billing で利用可能なクレジットを確認します。所有者としてのアクセスが必要なら、既存の試用をアカウントに連携してください。
- 429
- Retry-After に従ってください。同じ ID と登録証明を保持し、別の試用を作成しないでください。
- タイムアウトまたは送信結果が不明
- 再試行する前に既存の実行を確認します。CLI では同じプロファイルと実行 ID を使い、SDK/API では返されたジョブ ID やリクエスト ID を保持してください。