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

はじめに

TypeScript及びJavaScript SDK

SDKをインストールし、Node.jsで検索を実行します。 TypeScript または JavaScript を選択します。 API キーをサーバーに保存します。

  1. SDKをインストール

    これらの例では、Node.js 22.18+ を使用して、TypeScript を直接実行します。 package.jsonをお持ちの方は、空のフォルダから、既存のプロジェクトを選択して下さい。

    インストール
    npm init -y
    npm install --save-exact @flashdata-dev/[email protected]
  2. 認証

    Google Search 権限でキーを作成したり、認証されたキーを再使用したりします。 セットセット FLASHDATA_API_KEY このターミナルでは、隠れたプロンプトを使用して、環境が既にそれを供給している場合は、これをスキップします。

    例は明示的にキーを渡します。 .env ファイルはこれらのスクリプトによってロードされません。 Webアプリケーションに統合する際に、サーバー側の設定でキーを保持します。

    隠しキープロンプト・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. 検索を実行

    選択したファイルを保存し、このプロジェクトでコマンドを実行します。 各実行では、最大5件の検索結果が1件あります。 Node.jsで直接ファイルを実行します。この例ではビルドステップは必要ありません。

    quickstart.mts
    import { FlashData, type GoogleSearchParams } from '@flashdata-dev/sdk';
    
    const apiKey = process.env.FLASHDATA_API_KEY;
    if (!apiKey) throw new Error('Set FLASHDATA_API_KEY in the server environment.');
    const client = new FlashData({ apiKey });
    const params: GoogleSearchParams = { num: 5 };
    const response = await client.google.search({ query: 'battery recycling research', ...params });
    if (response.status !== 'done') throw new Error(JSON.stringify(response));
    
    for (const page of response.results) {
      for (const hit of page.organic ?? []) console.log(hit.title, hit.link);
    }
    console.log('Credits used:', response.usage.credits);
    走る · Node.js 22.18+
    node quickstart.mts
  4. 結果を確認

    スクリプトはステータスを確認し、ソースのタイトル、URLs、および使用されるクレジットを印刷します。 オーガニックの効能が有効です。 以下に出力された例は、形状を記述します。 ライブソースは異なります。

    出力例
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Google Searchのタイトル、リンク、スニペット。 他のソースには、独自の型付きペイロードがあります。
    usage.credits
    リクエストに請求されるクレジット。返されたヒット数が1件あります。

別のデータソースを試す

各タブはTypeScriptとJavaScriptの両方で動作します。 ファイルをステップ3から置換し、.mtsまたは.mjs拡張子を保持し、同じコマンドを実行します。 それぞれの実行は新しいリクエストで、ソースの権限が示されている必要があります。

google_newsが必要です。 results[].news[]の記事のエントリを読んでください。

quickstart.mts / quickstart.mjs
import { 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.news({
  query: 'battery recycling', num: 5,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);

TypeScriptプロジェクトをタイプチェック

ノードは、この例をストリッピングタイプで実行します。 リクエストを送信せずにタイプをチェックするには、TypeScript をインストールし、コンパイラを --noEmit で実行します。:

オプションタイプチェック
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmit

SDKがサポートしているもの

google / youtube
構造化されたデータをタイプされたソースヘルパーで検索し、取得します。 クライアントをサービスで再利用します。
youtube.download
バックグラウンドジョブで音声またはビデオをクラウドストレージに配信します。 youtube_download の許可および貯蔵構成を要求して下さい。
jobs / bulk
提出されたジョブIDsを保存し、完了した結果を取得します。 JavaScriptで待ちます。 mode: 'async'は、サーバー側のバックグラウンドジョブを送信します。
account
作業を繰り返しる前にアクセス、残高、価格設定、制限、使用量をお読みください。
respondWith / accept
response.content の Markdown の第 2 引数として { respondWith: 'markdown' } を渡すか、{ accept: 'text/plain' } を文字列に渡します。 JSONオブジェクトはデフォルトです。

次のステップ

ステップが失敗した場合

パッケージまたはランタイムの欠落
このプロジェクトで、--version ノードをオンにして@flashdata-dev/sdk をインストールします。 上記の .mts または .mjs 拡張子を保持します。
401 / FLASHDATA_API_KEY
実行する端末で有効なキーを設定します。
403
このAPIキーでGoogle Searchを有効にします。
402
Billingは、利用可能なクレジット、または排出されたエージェントのトライアルを要求するかどうかをチェックします。
429
Retry-Afterを待ってから、リクエスト率を削減します。
タイムアウトまたはサーバーエラー
History を再送する前にチェックします。最初のリクエストは既に実行されている可能性があります。