Przeglądaj dokumentację
Pierwsze kroki
Zainstaluj SDK i przeszukaj Node.js. Wybierz TypeScript lub JavaScript; trzymaj klucze API na serwerze.
Zainstaluj SDK
Przykłady te wykorzystują Node.js 22.18 + do bezpośredniego uruchamiania TypeScript. Zacznij w pustym folderze lub wybierz istniejący projekt, jeśli masz package.json.
Zainstalujnpm init -y npm install --save-exact @flashdata-dev/[email protected]Zainstalujnpm install --save-exact @flashdata-dev/[email protected]Uwierzytelnij
Utwórz klucz za zgodą Google Search lub ponownie użyj autoryzowanego klucza. Ustaw FLASHDATA_API_KEY w tym terminalu za pomocą ukrytego sygnału poniżej; pomiń to, jeśli środowisko już go dostarcza.
Przykład ten wyraźnie podaje klucz. Plik .env nie jest wczytywany przez te skrypty. Keep the key in server- side configuration podczas integracji z aplikacją internetową.
Ukryty sygnał klawiszowy · 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_KEYUkryty sygnał klawiszowy · 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 flashdataSecureKeyWykonaj wyszukiwanie
Zapisz zaznaczony plik i uruchom jego polecenie w tym projekcie. Każda runda przedstawia jedno wyszukiwanie do pięciu wyników. Oba pliki są uruchamiane bezpośrednio za pomocą Node.js; nie jest potrzebny żaden krok budowy.
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);Uruchom · 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);Uruchomnode quickstart.mjsSprawdź wynik
Status sprawdzania skryptu jest gotowy i drukuje tytuły źródłowe, URLs i kredyty używane. Pusty wynik organiczny jest ważny. Poniższy przykład przedstawia kształt; źródła na żywo będą się różnić.
Przykład wyjściaBattery recycling research https://example.org/recycling Credits used: 0.02results[].organic[]- Tytuł Google Search, linki i wyszczerbienia. Inne źródła mają własne ładunki na maszynie.
usage.credits- Kredyty naliczane za to żądanie; pięć zwróconych trafień to jedno żądanie wyszukiwania.
Spróbuj innego źródła danych
Każda karta działa zarówno w TypeScript, jak i JavaScript. Zamień plik z kroku 3, zachowaj jego rozszerzenie .mts lub .mjs i uruchom to samo polecenie. Każda operacja jest nowym wnioskiem i potrzebuje pokazanego pozwolenia źródłowego.
Wymaga google_news. Przeczytaj wpisy artykułu w 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);Wymaga youtube_metadata. Zwraca tytuły, kanały, czas trwania i inne szczegóły wideo.
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);Wymaga youtube_transcript. Prosi o istniejący angielski automatyczny utwór. Tekst znajduje się w results[].fullText, gdy utwór jest dostępny.
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);Sprawdź typ projektu TypeScript
Węzeł uruchamia ten przykład poprzez rozbieranie typów. Aby sprawdzić typy bez wysyłania wniosku, zainstalować TypeScript i uruchomić kompilator z --noEmit:
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmitCo obsługuje SDK
google / youtube- Wyszukiwarka i pobieranie uporządkowanych danych za pomocą wpisywanych pomocników źródłowych. Wykorzystaj jednego klienta do swoich usług.
youtube.download- Dostarcz audio lub wideo do pamięci masowej w chmurze poprzez zadanie w tle. Wymaga zezwolenia youtube_download i konfiguracji zapisu.
jobs / bulk- Zapisz złożone zadanie IDs i pobrać zakończone wyniki. Oczekuj oczekujących w JavaScript; mode: 'async' przedstawia zadanie serwera w tle.
account- Odczyt dostępu, równowagi, cen, ograniczeń i wykorzystania przed powtarzającą się pracą.
respondWith / accept- Podaj { respondWith: 'markdown' } jako drugi argument metody dla Markdown w response.content lub { accept: 'text/plain' } dla łańcucha. Obiekty JSON są domyślne.
Kolejne kroki
Jeśli krok zawiedzie
- Brak opakowania lub czasu startowego
- Sprawdź węzeł --version i zainstaluj @ flashdata-dev/sdk w tym projekcie. Należy zachować powyższe rozszerzenie .mts lub .mjs.
- 401 / FLASHDATA_API_KEY
- Ustaw poprawny klucz w terminalu, w którym uruchomisz przykład.
- 403
- Włącz Google Search dla tego klawisza API.
- 402
- Sprawdź Billing dostępne kredyty, lub zażądać wyczerpanego procesu agenta.
- 429
- Poczekaj na Retry-After, a następnie zmniejsz stawkę zapotrzebowania.
- Błąd timeout lub serwera
- Zaznacz History przed zwrotem; pierwsze żądanie może być już uruchomione.