浏览文档
开始使用
安装 SDK,在 Node.js 中执行搜索。支持 TypeScript 与 JavaScript;API Key 保存在服务端。
安装 SDK
示例使用 Node.js 22.18+ 直接运行 TypeScript。在空目录开始;已有 package.json 时选择已有项目。
安装npm init -y npm install --save-exact @flashdata-dev/[email protected]安装npm install --save-exact @flashdata-dev/[email protected]认证
创建具有 Google 搜索权限的密钥或复用授权密钥。通过下方隐藏提示在当前终端设置 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隐藏密钥输入 · PowerShell# 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执行搜索
保存所选文件,在项目中执行对应命令。每次运行提交一次搜索,最多获取五条结果。两种文件均直接通过 Node.js 运行,此示例无需构建。
quickstart.mtsimport { 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.mtsquickstart.mjsimport { FlashData } 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 response = await client.google.search({ query: 'battery recycling research', num: 5 }); 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 quickstart.mjs检查结果
脚本检查 status 为 done,并输出来源标题、URL 和消耗的 Credits。organic 为空属于有效结果。下方输出仅说明结构,实际来源会变化。
输出示例Battery recycling research https://example.org/recycling Credits used: 0.02results[].organic[]- Google 搜索标题、链接和摘要。其他来源有各自的类型化结果。
usage.credits- 此请求扣除的 Credits;返回五条结果属于一次搜索请求。
尝试其他数据源
每个标签页均支持 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);需要 youtube_metadata 权限。返回标题、频道、时长等视频详情。
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.youtube.metadata({
video_id: 'dQw4w9WgXcQ', include_formats: false,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);需要 youtube_transcript 权限。读取已有英文自动轨道。轨道可用时,文本位于 results[].fullText。
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.youtube.transcript({
video_id: 'dQw4w9WgXcQ', language: 'en', auto: true,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);检查 TypeScript 项目的类型
Node 通过移除类型运行此示例。若要检查类型而不发送请求,可安装 TypeScript 并以 --noEmit 运行编译器:
可选类型检查
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmitSDK 支持的功能
google / youtube- 使用类型化来源方法搜索并获取结构化数据。在服务内复用同一客户端。
youtube.download- 通过后台任务将音频或视频交付到云存储。需要 youtube_download 权限及存储配置。
jobs / bulk- 保存已提交任务 ID,并获取完成结果。await 在 JavaScript 中等待;mode: 'async' 则提交服务端后台任务。
account- 定时任务前读取权限、余额、价格、限额和用量。
respondWith / accept- 将 { respondWith: 'markdown' } 作为方法第二个参数,从 response.content 获取 Markdown;或传入 { accept: 'text/plain' } 获取字符串。默认返回 JSON 对象。