Jelajahi dokumentasi
Mulai
Pasang SDK dan jalankan pencarian dalam Node.js. Pilih TypeScript atau JavaScript; simpan kunci API di server.
Pasang SDK
Contoh-contoh ini menggunakan Node.js 22.18+ untuk menjalankan TypeScript secara langsung. Mulai dari folder kosong, atau pilih projek Existing bila Anda memiliki package.json.
Instalnpm init -y npm install --save-exact @flashdata-dev/[email protected]Instalnpm install --save-exact @flashdata-dev/[email protected]Otentikasi
Buat kunci dengan izin Google Search atau gunakan kembali kunci yang berwenang. Set FLASHDATA_API_KEY dalam terminal ini menggunakan prompt tersembunyi di bawah ini; lewati ini jika lingkungan anda sudah memasoknya.
Contoh melewati kunci secara eksplisit. Berkas .env tidak dimuat oleh skrip ini. Simpan kunci dalam konfigurasi sisi-server ketika mengintegrasikan ke dalam aplikasi web.
Prompt kunci tersembunyi 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_KEYPrompt kunci tersembunyi 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 flashdataSecureKeyJalankan pencarian
Simpan berkas yang dipilih dan jalankan perintah dalam proyek ini. Masing-masing berlari menyerahkan satu pencarian sampai lima hasil. Kedua berkas dijalankan secara langsung dengan Node.js; tidak ada langkah membangun diperlukan untuk contoh ini.
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);Jalankan 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);Jalankannode quickstart.mjsPeriksa hasil
Status pemeriksaan naskah dilakukan dan mencetak judul sumber, URLs dan kredit yang digunakan. Hasil organik kosong valid. Contoh keluaran di bawah ini menggambarkan bentuk; sumber langsung akan bervariasi.
Contoh keluaranBattery recycling research https://example.org/recycling Credits used: 0.02results[].organic[]- Judul Google Search, link dan snippet. Sumber lain memiliki mereka sendiri diketik payloads.
usage.credits- Kredit yang dibebankan untuk permintaan ini; lima hits yang kembali adalah satu permintaan pencarian.
Coba sumber data lain
Setiap tab bekerja di TypeScript dan JavaScript. Ganti berkas dari step 3, simpan .mts atau .mjs ekstensi dan jalankan perintah yang sama. Setiap lari adalah permintaan baru dan perlu izin sumber yang ditunjukkan.
Membutuhkan google_news. Baca entri artikel di 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);Membutuhkan youtube_metadata. Mengembalikan judul, saluran, durasi dan rincian video lainnya.
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);Membutuhkan youtube_transcript. Meminta trek otomatis Inggris yang ada. Teks dalam results[].fullText ketika trek tersedia.
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);Type- periksa projek TypeScript
Node berjalan contoh ini dengan stripping tipe. Untuk memeriksa tipe tanpa mengirim permintaan, instal TypeScript dan menjalankan kompiler dengan --noEmit:
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmitApa dukungan SDK
google / youtube- Cari dan ambil data terstruktur dengan sumber pembantu diketik. Gunakan kembali satu klien dalam pelayananmu.
youtube.download- Kirim audio atau video ke penyimpanan awan Anda melalui pekerjaan latar belakang. Membutuhkan izin youtube_download dan konfigurasi penyimpanan.
jobs / bulk- Simpan tugas yang diajukan IDs dan ambil hasil yang selesai. menunggu di JavaScript; mode: 'async' menyerahkan sebuah pekerjaan latar belakang pelayan.
account- Baca akses, keseimbangan, harga, batas dan penggunaan sebelum pekerjaan berulang.
respondWith / accept- Pass { respondWith: 'markdown' } sebagai metode argumen kedua untuk Markdown in response.content, atau { accept: 'text/plain' } untuk sebuah string. Benda JSON adalah yang utama.
Langkah selanjutnya
Jika satu langkah gagal
- Paket atau waktu jalan hilang
- Periksa titik --version dan pasang @ flashdata-dev/sdk dalam proyek ini. Pertahankan ekstensi .mts atau .mjs yang ditampilkan diatas.
- 401 / FLASHDATA_API_KEY
- Atur kunci yang valid di terminal di mana Anda menjalankan contoh.
- 403
- Aktifkan Google Search untuk kunci API ini.
- 402
- Periksa Billing untuk kredit yang tersedia, atau klaim kelelahan agen pengadilan.
- 429
- Tunggu Retry-After, kemudian kurangi tingkat permintaan Anda.
- Tenggat waktu atau galat server
- Periksa History sebelum mengirim ulang; permintaan pertama mungkin sudah dijalankan.