Обзор документации
Начало работы
Установите Python SDK и распечатайте результаты поиска с помощью нескольких строк кода. Включает синхронные и асинхронные примеры.
Установите SDK
Требуется Python 3.10+. Запустите эти команды в каталоге вашего проекта. Вы уже используете виртуальную среду? Установить flash-данные==1.1.0 В этой среде python -m pip Вместо этого.
Установитьpython3 -m venv .venv .venv/bin/python -m pip install "flashdata==1.1.0"Установитьpy -3 -m venv .venv .\.venv\Scripts\python.exe -m pip install "flashdata==1.1.0"аутентифицировать
Создайте ключ API с разрешением 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Выполните поиск
Сохраните это как quickstart.py, а затем запустите его в той же виртуальной среде. Он делает один запрос Google Search для пяти результатов и печатает заголовки, URLs и использованные кредиты.
quickstart.pyimport 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"])Запустить.venv/bin/python quickstart.pyЗапустить.\.venv\Scripts\python.exe quickstart.pyПроверьте результат
Сценарий обычно выходит после проверки статуса. Ожидайте названия источников и URLs, за которыми следуют используемые кредиты. Пустой органический список является правильным ответом; результаты варьируются в зависимости от вашего запроса.
Примерный выходBattery recycling research https://example.org/recycling Credits used: 0.02results[].organic[]- Google Search хиты: заголовок, ссылка и фрагмент. Другие источники имеют разные поля результатов.
usage.credits- Стоимость этого запроса. До пяти результатов – один поисковый запрос.
Попробуйте другой источник данных
Каждая вкладка представляет собой полный сценарий. Замените quickstart.py одним примером и запустите его с помощью команды шага 3. Каждый запуск отправляет один новый запрос; ключ нуждается в указанном разрешении источника.
Требуется google_news. Печатает заголовки статей и ссылки на источники от results[].news[].
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"))Требуется youtube_metadata. Печатает заголовок видео, канал и продолжительность в считанные секунды. Замените видео ID на то, которое вы хотите проверить.
import os
from flashdata import FlashData
with FlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client:
response = client.youtube.metadata("dQw4w9WgXcQ", include_formats=False)
if response["status"] != "done":
raise RuntimeError(response)
for video in response["results"]:
print(video.get("title"), video.get("channel"))
print("Seconds:", video.get("duration"))Требуется youtube_transcript. Отпечатывает существующую английскую автоматическую расшифровку от results[].fullText. Видео должно иметь эту дорожку; этот вызов не генерирует и не переводит подписи.
import os
from flashdata import FlashData
with FlashData(api_key=os.environ["FLASHDATA_API_KEY"]) as client:
response = client.youtube.transcript("dQw4w9WgXcQ", language="en", auto=True)
if response["status"] != "done":
raise RuntimeError(response)
for track in response["results"]:
print(track.get("fullText", ""))Что поддерживает Python SDK
google / youtube- Google Search, Новости, Изображения, Покупки, Видео и Места; Открытие YouTube, метаданные, подписи, транскрипты и данные канала.
youtube.download- Отправьте работу по доставке аудио или видео в ваше облачное хранилище. Требуется разрешение youtube_download и конфигурация хранилища; следуйте примеру полной загрузки ниже.
jobs / bulk- Сохраните принятую работу ID, дождитесь завершения и получите результаты. Используйте оптом для больших наборов данных видео-ID и возобновите существующие рабочие места после перезагрузки.
account- Прочитайте доступ, баланс, цены, ограничения и использование перед повторными работами. Повторное использование авторизованного ключа из вашей среды или секретного магазина.
respond_with / accept- Используйте respond_with="markdown" для Markdown в ответ ["content"] или примите = "text/plain" для строки. Словари JSON являются по умолчанию.
Используйте асинчо
Замените quickstart.py этой версией и используйте ту же команду запуска. AsyncFlashData предоставляет те же ресурсы с ожиданием. Это все еще ждет ответа в режиме реального времени; mode="async" вместо этого отправляет фоновую работу на стороне сервера.
В Jupyter или приложении с запущенным циклом событий используйте ожидание main() вместо asyncio.run(main()). Повторное использование клиента в рамках этого цикла событий.
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())Следующие шаги
Если шаг не удался
- ModuleNotFoundError
- Установите и запустите с тем же интерпретатором: .venv/bin/python -m pip show flashdata (Windows: .\.venv\Scripts\python.exe -m pip show flashdata). Не называйте свой сценарий flashdata.py.
- KeyError: FLASHDATA_API_KEY / 401
- Установите активный ключ API в том же терминале. Один только файл .env не загружается этим примером. Используйте ключ API, а не MCP OAuth.
- 403
- Предоставьте исходное разрешение, требуемое примером, этому ключу.
- 402
- Проверьте Billing для доступных кредитов. Если пробный доступ исчерпан, заявите о подключении, чтобы использовать баланс вашего счета.
- 429 / APIError
- Проверьте error.retry_after и уменьшите скорость запроса. SDK отправляет каждый запрос один раз и не перезапускает автоматически.
- SubmissionUnknownError
- Уже сейчас может быть принято временное представление. Проверьте History, прежде чем повторить его; повторно используйте сохраненную работу ID, когда она доступна.
- asyncio.run() / running event loop
- Используйте ожидание main() в блокноте или существующем цикле событий. Храните asyncio.run(main()) для автономного сценария.