Обзор документации
Начало работы
Установите SDK и запустите поиск в Node.js. Выберите TypeScript или JavaScript; сохраняйте ключи API на сервере.
Установите 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 Search или повторно используйте авторизованный ключ. Установите 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Проверьте результат
Сценарий проверяет статус и печатает заголовки источников, URLs и используемые кредиты. Чистые органические результаты действительны. Приведенный ниже пример иллюстрирует форму; живые источники будут различаться.
Примерный выходBattery recycling research https://example.org/recycling Credits used: 0.02results[].organic[]- Google Search заголовки, ссылки и фрагменты. Другие источники имеют свои собственные типизированные полезные нагрузки.
usage.credits- Кредиты, взимаемые за этот запрос; пять возвращенных хитов - один поисковый запрос.
Попробуйте другой источник данных
Каждая вкладка работает как в TypeScript, так и в JavaScript. Замените файл с шага 3, сохраните расширение .mts или .mjs и запустите ту же команду. Каждый запуск представляет собой новый запрос и требует разрешения источника.
Требуется google_news. Прочитайте статьи в results[].news[].
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. Возвращает заголовки, каналы, продолжительность и другие видео детали.
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, когда трек доступен.
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
Узел запускает этот пример с помощью типов стриптиза. Для проверки типов без отправки запроса установите 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- Перейдите { respondWith: 'markdown' } как второй аргумент метода для Markdown в response.content или { accept: 'text/plain' } для строки. Объекты JSON являются по умолчанию.
Следующие шаги
Если шаг не удался
- Отсутствует пакет или время выполнения
- Проверьте узел --version и установите @flashdata-dev/sdk в этом проекте. Держите расширение .mts или .mjs, показанное выше.
- 401 / FLASHDATA_API_KEY
- Установите действительный ключ в терминале, где вы запускаете пример.
- 403
- Включите Google Search для этого ключа API.
- 402
- Проверить Billing на наличие кредитов или потребовать исчерпанного агента.
- 429
- Подождите Retry-After, а затем уменьшите скорость запроса.
- Тайм-аут или ошибка сервера
- Проверьте History перед отправкой; первый запрос, возможно, уже запущен.