Обзор документации
Начало работы
Проверяйте запрос, запускайте его из сценария и читайте отдельные квитанции о результатах и ошибках.
На этой странице
1. Выберите существующий профиль
Используйте CLI, Bash и jq. На Windows запустите примеры оболочки в Git Bash. В этом прохождении используется аутентифицированный профиль исследования; установите FLASHDATA_STATE_DIR в абсолютный каталог, где хранится этот профиль.
Используйте один и тот же пользователь OS и каталог состояния в каждой команде. FLASHDATA_API_KEY переопределяет сохраненный ключ, оставляя его незагруженным для использования профиля. CLI не загружает файлы .env.
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata auth status --profile research --state-dir "$FLASHDATA_STATE_DIR" --jsonМестоположение Default State
Используйте свой оригинальный --state-dir, если вы выбрали специальное местоположение. auth status должен сообщать о data.accessVerified: true. Для необслуживаемого развертывания импортируйте ключ владельца через stdin из своего секретного магазина.
| OS | Директория |
|---|---|
| Windows | %APPDATA%/FlashData |
| macOS | ~/Library/Application Support/FlashData |
| Linux | $XDG_STATE_HOME/flashdata или ~/.local/state/flashdata |
2. Проверить запрос и цену
Сохраните request.json, затем запустите бесплатные чеки в том же каталоге. Фильтр печатает true только тогда, когда доступна цена источника и баланс покрывает один запрос. Остановитесь на ненулевом выходе. Проверка цен не резервирует кредиты.
{
"source": "google_search",
"query": "battery recycling research",
"params": {
"num": 5
}
}set -euo pipefail
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata account balance --profile research --state-dir "$FLASHDATA_STATE_DIR" \
--json --non-interactive > balance.json
flashdata query --input request.json --dry-run --run-id cli-research-001 \
--profile research --state-dir "$FLASHDATA_STATE_DIR" \
--json --non-interactive > preflight.json
jq -e --slurpfile balance balance.json '
.ok and .data.dryRun and .data.estimateAvailable
and ($balance[0].ok == true)
and any(.data.estimate.prices[]?;
.source == "google_search" and .available == true
and (.estimatedCredits | type == "number")
and ($balance[0].data.availableCredits | type == "number")
and .estimatedCredits <= $balance[0].data.availableCredits)
' preflight.json3. Беги и читай квитанцию
После прохождения чеков сохраните run-search.sh и запустите bash run-search.sh. Первое успешное исполнение представляет один поиск. Каждая попытка сохраняет свои файлы в новом каталоге cli-run; стабильный запуск ID позволяет CLI повторно использовать более ранний успех для той же учетной записи, профиля и каталога состояния.
#!/usr/bin/env bash
set -euo pipefail
umask 077
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
dir=$(mktemp -d "cli-run.XXXXXX")
if ! flashdata query --input request.json --run-id cli-research-001 \
--profile research --state-dir "$FLASHDATA_STATE_DIR" \
--output "$dir/result.json" --timeout 2m --json --non-interactive \
> "$dir/receipt.json" 2> "$dir/error.json"; then
cat "$dir/error.json" >&2
printf 'Inspect saved run cli-research-001; receipts: %s\n' "$dir" >&2
exit 1
fi
jq -e '.schemaVersion == 1 and .ok == true' "$dir/receipt.json" >/dev/null
jq -e '.status == "done" and .source == "google_search"' "$dir/result.json" >/dev/null
jq -r '.results[]?.organic[]? | [.title, .link] | @tsv' "$dir/result.json"
jq '{runId, cached, usage}' "$dir/receipt.json"
printf 'Files: %s\n' "$dir"Знать, какой файл читать
Конверт CLI и ответ источника представляют собой различные документы JSON. Без --output исходный ответ находится в данных. В этом примере используется --output, поэтому считывайте исходные поля из сохраненного result.json.
| Файл | Читать |
|---|---|
| receipt.json | ОК, runId, кэширование, использование и выходной путь. Кэшированная квитанция сообщает о первоначальном использовании, а не о новой плате. |
| result.json | Источник, статус, результаты и использование. Для Google Search прочитайте results[].organic[]. Пустой массив может быть действительным результатом поиска. |
| error.json | При ненулевом выходе проверьте error.code, error.httpStatus, error.retryAfter и любой run/job IDs. |
{
"schemaVersion": 1,
"ok": true,
"runId": "cli-research-001",
"cached": false,
"data": {
"output": "cli-run.EXAMPLE/result.json"
},
"usage": {
"credits": 0.02
}
}Восстановление без очередного поиска
Проверьте сохраненный пробег перед повторным использованием. С доступом к исходной учетной записи экспортируйте успешный запуск в имя файла, которого еще не существует. Претензии переходят с пробной учетной записи на владельца; сохраняйте ранее экспортированные результаты испытаний и используйте новый IDs для новых задач владельца. Измененный запрос под тем же самым запуском ID отклоняется; используйте новый ID только для преднамеренной новой задачи.
flashdata runs show cli-research-001 --profile research \
--state-dir "$FLASHDATA_STATE_DIR" --json
flashdata runs show cli-research-001 --result --output recovered.json \
--profile research --state-dir "$FLASHDATA_STATE_DIR" --jsonДобавьте расписание, когда сценарий работает
Используйте --recurring с установленным доступом владельца, одним постоянным ID на каждый запланированный запуск и сохраняемым состоянием. Пробный доступ не подходит для регулярных задач. Расписание задаёт хост; флаг лишь проверяет доступ. Для обработки дат и перезапуска используйте полный пример запуска регулярной задачи.
Дополнительно: Private download storage
Для загрузки на YouTube --storage-config storage.json сохраните только этот объект хранения в виде storage.json и замените заполнители локально. Файл должен быть частным и принадлежать исполняющему пользователю. Используйте команду согласования разрешений перед запуском загрузки.
{
"storage_type": "s3",
"storage_url": "YOUR_BUCKET",
"access_key": "YOUR_ACCESS_KEY",
"secret_key": "YOUR_SECRET_KEY",
"region": "us-east-1"
}chmod 600 storage.json$storagePath = (Resolve-Path -LiteralPath './storage.json').Path
$storageUser = [System.Security.Principal.WindowsIdentity]::GetCurrent().User
$storageAcl = [System.Security.AccessControl.FileSecurity]::new()
$storageAcl.SetOwner($storageUser)
$storageAcl.SetAccessRuleProtection($true, $false)
$storageAcl.AddAccessRule([System.Security.AccessControl.FileSystemAccessRule]::new($storageUser, 'FullControl', 'Allow'))
Set-Acl -LiteralPath $storagePath -AclObject $storageAcl