Explorar documentación
Primeros pasos
Valida una solicitud, ejecútala desde un script y consulta por separado el resultado y los registros de error.
En esta página
1. Seleccione el perfil existente
Utilice el CLI instalado, Bash y jq. En Windows, ejecute los ejemplos de shell en Git Bash. Este recorrido utiliza un perfil de investigación autenticado; establezca FLASHDATA_STATE_DIR al directorio absoluto donde se almacena ese perfil.
Utilice el mismo directorio de usuario y estado de OS en cada comando. FLASHDATA_API_KEY anula la tecla guardada; deje que se desenganche para utilizar el perfil. El CLI no carga archivos .env.
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata auth status --profile research --state-dir "$FLASHDATA_STATE_DIR" --jsonLocalidades estatales predeterminadas
Utilice su --state-dir original si usted eligió una ubicación personalizada. estado de auth debe informar data.accessVerified: verdadero. Para un despliegue no deseado, importar la llave del propietario a través de stdin de su tienda secreta.
| OS | Directorio |
|---|---|
| Windows | %APPDATA%/FlashData |
| macOS | ~/Library/Application Support/FlashData |
| Linux | $XDG_STATE_HOME/flashdata o ~/.local/state/flashdata |
2. Validar la solicitud y el precio
Guardar request.json, luego ejecutar los cheques gratuitos en el mismo directorio. El filtro se imprime sólo cuando hay un precio de fuente disponible y el saldo cubre una consulta. Deténgase en una salida no cero. Un cheque de precio no se reserva créditos.
{
"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. Corre y lee el recibo
Después de pasar los cheques, guardar run-search.sh y ejecutar bash run-search.sh. La primera ejecución exitosa presenta una búsqueda. Cada intento guarda sus archivos en un nuevo directorio de gestión de cli; el funcionamiento estable ID permite que el CLI reutiliza un éxito anterior para la misma cuenta, perfil y directorio estatal.
#!/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"Saber qué archivo leer
El sobre CLI y la respuesta de la fuente son diferentes documentos JSON. Sin --output, la respuesta de la fuente está en datos. Este ejemplo utiliza --output, por lo que lee los campos de origen del result.json guardado.
| Archivo | Leer |
|---|---|
| receipt.json | ok, runId, caché, uso y la ruta de salida. Un recibo caché reporta el uso original, no un nuevo cargo. |
| result.json | fuente, estado, resultados y uso. Para Google Buscar, lea results[].organic[]. Un array vacío puede ser un resultado de búsqueda válido. |
| error.json | En la salida no cero, inspeccione error.code, error.httpStatus, error.retryAfter y cualquier run/job IDs. |
{
"schemaVersion": 1,
"ok": true,
"runId": "cli-research-001",
"cached": false,
"data": {
"output": "cli-run.EXAMPLE/result.json"
},
"usage": {
"credits": 0.02
}
}Recuperar sin otra búsqueda
Inspeccione la ejecución guardada antes de reintentar. Con el acceso a la cuenta original, exporte una ejecución exitosa a un nombre de archivo que aún no existe. Reclamación de conmutadores de la cuenta de prueba al propietario; mantenga los resultados de prueba previamente exportados y utilice nuevo IDs para nuevas tareas del propietario. Una solicitud modificada bajo la misma ejecución ID es rechazada; use un nuevo ID sólo para una nueva tarea intencionada.
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" --jsonAñadir programación cuando el script funciona
Utilice --recurring con acceso al propietario instalado, un ID estable por ocurrencia programada y estado persistente. Un ensayo no puede ejecutar trabajo recurrente. Su anfitrión es el propietario del horario; la bandera sólo verifica el acceso. Utilice el corredor de tinta recurrente completo para el manejo y reinicias programados.
Opcional: almacenamiento de descarga privada
Para youtube descargar --storage-config storage.json, guarde sólo este objeto de almacenamiento como storage.json y sustitúyalo localmente. El archivo debe ser privado y propiedad del usuario ejecutante. Utilice el comando de permiso de coincidencia antes de ejecutar una descarga.
{
"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