Skip to main content
POST
新しいバッチを開始
完了時に通知を受け取る: バッチが完了したときにHTTP POSTを受け取るために、webhook パラメータにエンドポイントURLを渡します。詳細はWebhooksを参照してください。
カスタムデータを添付する: metadata パラメータを使用してキーと値のペアを保存します。2つのレベルでサポートされています:
  • バッチレベル — リクエストボディに
  • アイテムレベルitems 配列内の各アイテムに
詳細はMetadataを参照してください。

承認

Authorization
string
header
必須

Bearer 形式のBearer認証ヘッダー。はあなたの認証トークンです。

ボディ

application/json
items
object[]
必須

バッチで処理されるアイテムの配列。

country
string

バッチ実行の国。ISO 3166-1 alpha-2 コードで提供してください。例: US(USA), IN(India) など。

parser
object

このパラメーターを使って使用するパーサーを指定できるよ。パーサーはウェブページから構造化されたコンテンツを抽出するのに便利だよ。Olostepには一般的なウェブページ用のパーサーがいくつか組み込まれていて、自分でパーサーを作成することもできるよ。

バッチ内の各ページに存在するすべてのリンクを取得するよ。リンクは常に絶対URLとして返されるよ。

metadata
object

オブジェクトに関する追加情報を保存するためのキーと値のペアのセット。Stripeのアプローチに従い、検証ルールがあります:最大50キー、キーは最大40文字(角括弧なし)、値は最大500文字、すべての値は文字列として保存されます。

:
webhook
string<uri>

バッチが完了したときにPOSTリクエストを受け取るためのHTTPS URL。http:// または https:// プロトコルを使用して、公開アクセス可能なURLでなければならないよ。localhostやプライベートIPアドレスを指すことはできないよ。Webhooksでペイロードの形式とリトライの動作を確認してね。

レスポンス

バッチが正常に開始されました。

id
string

バッチ ID

object
string

オブジェクトの種類。このエンドポイントでは "batch" だよ。

status
string

in_progress または completed

created
number

作成されたエポック

total_urls
number

バッチ内のURLの数

completed_urls
number

完了したURLの数

parser
string
country
string
metadata
object

オブジェクトに関する追加情報を保存するためのキーと値のペアのセット。Stripeのアプローチに従い、検証ルールがあります:最大50キー、キーは最大40文字(角括弧なし)、値は最大500文字、すべての値は文字列として保存されます。

:
webhook
string

完了通知を受け取るためのWebhook URL

credits_consumed
integer | null

このリクエストで消費されたクレジットの数。実行完了後に設定されるよ。クレジットは請求の基準だよ。

cost_usd
number | null

このリクエストのUSDでの推定コスト。実行完了後に設定されるよ。消費されたクレジットとプランのレートから計算されるよ — 99%の精度だけど、credits_consumedが正確な値だよ。