Chuyển đến nội dung
VI
Lấy khóa API
Duyệt tài liệu

Bắt đầu

Python SDK khởi chạy nhanh

Cài đặt Python SDK và in kết quả tìm kiếm với vài dòng mã. Bao gồm cả những ví dụ đồng bộ và đặc trưng.

  1. Cài đặt SDK

    Yêu cầu Python 3.10+. Chạy những lệnh này trong thư mục dự án của bạn. Đã sử dụng môi trường ảo chưa? Cài đặt==1.1.0 với môi trường python -m pip Thay vào đó.

    Cài đặt
    python3 -m venv .venv
    .venv/bin/python -m pip install "flashdata==1.1.0"
  2. Xác thực

    Tạo ra một API phím với Google Search cho phép, hoặc sử dụng lại một phím được ủy quyền. Đặt nó trong thiết bị cuối này bằng dấu nhắc ẩn bên dưới.

    Bỏ qua dấu nhắc nếu FLASHDATA_API_KEY đã được thiết lập. Những ví dụ này đọc trực tiếp biến; chúng không tải tập tin .env.

    Phím ẩn nhắc điều · 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
  3. Chạy tìm kiếm

    Lưu vào quickstart.py, sau đó chạy cùng một môi trường ảo. Nó làm ra một cái Google Search Yêu cầu cho đến năm kết quả và in tiêu đề, URLs và dùng tín dụng.

    quickstart.py
    import os
    from flashdata import FlashData
    
    with FlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client:
        response = client.google.search("battery recycling research", num=5)
        if response["status"] != "done":
            raise RuntimeError(response)
        for page in response["results"]:
            for hit in page.get("organic", []):
                print(hit["title"], hit["link"])
        print("Credits used:", response["usage"]["credits"])
    Chạy
    .venv/bin/python quickstart.py
  4. Kiểm tra kết quả

    Thông thường, khi kiểm tra xong trạng thái, tập lệnh sẽ được thoát. Mong đợi tên nguồn và URLs Sau đó là các nguồn tư liệu được sử dụng. Một danh sách hữu cơ rỗng là một câu trả lời hợp lệ; kết quả khác nhau với yêu cầu của bạn.

    Đầu ra Ví dụ
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Google Search truy cập: tiêu đề, liên kết và trích. Những nguồn khác thì có những trường kết quả khác nhau.
    usage.credits
    Chi phí cho yêu cầu này. Kết quả là một yêu cầu tìm kiếm.

Thử một nguồn dữ liệu khác

Mỗi thẻ là một văn lệnh đầy đủ. Thay thế quickstart.py với một ví dụ và chạy nó với lệnh từ bước 3. Mỗi lần chạy đệ trình một yêu cầu mới; chìa khóa cần sự cho phép nguồn.

Yêu cầu google_news. In tựa bài và liên kết nguồn từ results[].news[].

quickstart.py
import os
from flashdata import FlashData

with FlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client:
    response = client.google.news("battery recycling", num=5)
    if response["status"] != "done":
        raise RuntimeError(response)
    for page in response["results"]:
        for article in page.get("news", []):
            print(article.get("title"), article.get("link"))

Cái quái gì... Python SDK Hỗ trợ

google / youtube
Google SearchTin tức, hình ảnh, mua sắm, videos và Places; YouTube Khám phá, siêu dữ liệu, chú thích, ghi chép và dữ liệu kênh.
youtube.download
Gửi một công việc chuyển phát âm thanh hay video đến kho lưu trữ đám mây của bạn. Yêu cầu youtube_download cho phép và cấu hình lưu trữ; theo sau toàn bộ việc tải về ví dụ bên dưới.
jobs / bulk
Lưu công việc đã nhận IDChờ kết quả hoàn thành và lấy lại kết quả. Dùng số lượng lớn cho bộ dữ liệu video-ID lớn hơn và tiếp tục công việc đã có sau khi khởi động lại.
account
Đọc sách, giữ thăng bằng, giá cả, giới hạn và sử dụng trước khi làm việc lặp lại. Dùng lại chìa khóa được ủy quyền từ môi trường hay cửa hàng bí mật.
respond_with / accept
Dùng respond_with="markdown" Vì Markdown để đáp ứng["content"], hoặc chấp nhận ="text/plain" cho một sợi dây. JSON Từ điển là một điều mặc định.

Sử dụng một định kỳ

Thay thế quickstart.py bằng phiên bản này và sử dụng cùng một lệnh chạy. Một một điểm sốc đã phơi bày cùng những vật dụng để đợi. Điều này vẫn chờ đợi một đáp ứng tìm kiếm thời gian thực; mode="async" Thay vào đó, gửi một tác vụ nền của máy phục vụ.

Trong vòng lặp sự kiện đang chạy, hãy dùng tùy chọn này thay vào đó là đợi phím chính () asyncio.run(main) Hãy tái sử dụng khách hàng trong vòng lặp sự kiện đó.

quickstart.py
import asyncio
import os
from flashdata import AsyncFlashData

async def main():
    async with AsyncFlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client:
        response = await client.google.search("battery recycling research", num=5)
        if response["status"] != "done":
            raise RuntimeError(response)
        for page in response["results"]:
            for hit in page.get("organic", []):
                print(hit["title"], hit["link"])
        print("Credits used:", response["usage"]["credits"])

asyncio.run(main())

Bước kế

Nếu một bước không thành công

ModuleNotFoundError
Cài đặt và chạy với cùng một bộ giải thích: .venv/bin/python -m pip hiển thị đèn flashdata (Windows: .\.venv\Scripts\python.exe -m pip hiển thị flashdata). Đừng đặt tên cho văn lệnh của bạn flashdata.py.
KeyError: FLASHDATA_API_KEY / 401
Đặt hoạt động API Chìa khóa trong cùng một thiết bị cuối. Ví dụ này không thể tải chỉ một tập tin .env. Dùng a API không phải là... MCP OAuth làm ơn đi.
403
Hãy ban cho quyền truy cập nguồn cần thiết qua ví dụ về chìa khóa này.
402
Kiểm tra Billing cho các tín dụng có sẵn. Nếu quyền truy cập thử nghiệm bị cạn kiệt, hãy yêu cầu bạn dùng số tiền số dư tài khoản của bạn.
429 / APIError
Kiểm tra error.retry_after và giảm mức yêu cầu. Hạt SDK gửi mỗi yêu cầu một lần và không thử lại tự động.
SubmissionUnknownError
Có thể đã chấp nhận một sự phục tùng hết hạn. Kiểm tra History trước khi lặp lại; dùng lại một công việc đã lưu ID khi nào rảnh.
asyncio.run() / running event loop
Dùng đợi phím chính () trong sổ ghi chú hay vòng lặp sự kiện đã có. Giữ asyncio.run(mai) cho một văn lệnh đứng vững.