Sfoglia la documentazione
Per iniziare
Installare lo SDK ed eseguire una ricerca in Node.js. Scegliere TypeScript o JavaScript; tenere le chiavi API sul server.
Installare la SDK
Questi esempi utilizzano Node.js 22.18+ per eseguire direttamente TypeScript. Avviare in una cartella vuota o selezionare il progetto esistente se si dispone di package.json.
Installanpm init -y npm install --save-exact @flashdata-dev/[email protected]Installanpm install --save-exact @flashdata-dev/[email protected]Autentico
Creare una chiave con il permesso di ricerca Google o riutilizzare una chiave autorizzata. Impostare FLASHDATA_API_KEY in questo terminale utilizzando il prompt nascosto qui sotto; saltare questo se il vostro ambiente già lo fornisce.
L'esempio passa esplicitamente la chiave. Un file .env non è caricato da questi script. Mantenere la chiave nella configurazione lato server quando si integra in un'applicazione web.
Segnale chiave nascosta · 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_KEYSegnale chiave nascosta · 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 flashdataSecureKeyEsegui una ricerca
Salvare il file selezionato ed eseguire il suo comando in questo progetto. Ogni corsa presenta una ricerca fino a cinque risultati. Entrambi i file vengono eseguiti direttamente con Node.js; non è necessario alcun passo di costruzione per questo esempio.
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);Correre · 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);Eseguinode quickstart.mjsVerifica il risultato
Lo stato di controllo dello script viene fatto e stampa i titoli di origine, URLs e i crediti utilizzati. I risultati organici vuoti sono validi. L'uscita dell'esempio qui sotto illustra la forma; le fonti dal vivo variano.
Esempio di outputBattery recycling research https://example.org/recycling Credits used: 0.02results[].organic[]- Google Cerca titoli, link e snippet. Altre fonti hanno i propri carichi di pagamento digitati.
usage.credits- Crediti addebitati per questa richiesta; cinque colpi restituiti sono una richiesta di ricerca.
Prova un'altra fonte di dati
Ogni scheda funziona sia in TypeScript che in JavaScript. Sostituire il file dal passo 3, mantenere la sua estensione .mts o .mjs ed eseguire lo stesso comando. Ogni esecuzione è una nuova richiesta e ha bisogno del permesso di origine mostrato.
Richiede google_news. Leggi gli articoli in 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);Richiede youtube_metadata. Restituisce titoli, canali, durata e altri dettagli video.
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);Richiede youtube_transcript. Richiede una traccia automatica inglese esistente. Il testo è in results[].fullText quando la traccia è disponibile.
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);Controllare il progetto TypeScript
Node esegue questo esempio spogliando i tipi. Per controllare i tipi senza inviare una richiesta, installare TypeScript ed eseguire il compilatore con --noEmit:
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmitChe cosa supporta SDK
google / youtube- Cerca e recupera i dati strutturati con helper di origine digitata. Riutilizzare un cliente nel tuo servizio.
youtube.download- Fornisci audio o video al tuo cloud storage attraverso un lavoro di sfondo. Richiede il permesso youtube_download e la configurazione di archiviazione.
jobs / bulk- Salvare il lavoro inviato IDs e recuperare i risultati completati. attendere le attese in JavaScript; mode: 'async' presenta un lavoro di sfondo lato server.
account- Leggi l'accesso, l'equilibrio, i prezzi, i limiti e l'utilizzo prima del lavoro ricorrente.
respondWith / accept- Passare { respondWith: 'markdown' } come secondo argomento del metodo per Markdown in response.content, o { accept: 'text/plain' } per una stringa. Gli oggetti JSON sono di default.
Prossimo passo
Se un passo fallisce
- Pacchetto o runtime mancanti
- Controllare il nodo --version e installare @flashdata-dev/sdk in questo progetto. Mantenere l'estensione .mts o .mjs sopra indicato.
- 401 / FLASHDATA_API_KEY
- Impostare una chiave valida nel terminale in cui si esegue l'esempio.
- 403
- Abilitare Google Cercare questo tasto API.
- 402
- Controllare Billing per i crediti disponibili, o richiedere una prova agente esausta.
- 429
- Attendere Retry-After, quindi ridurre il tasso di richiesta.
- Errore di timeout o server
- Controllare History prima di effettuare il resending; la prima richiesta potrebbe già essere stata eseguita.