コンテンツへスキップ
APIリファレンス
APIリファレンス

バッチオブジェクト

互換性のある Batch API によって実行ライフサイクルが報告される、アカウントスコープのモデレーションバッチです。

互換性のある Batch API によって実行ライフサイクルが報告される、アカウントスコープのモデレーションバッチです。

01

オブジェクトフィールド

JSONボディ

リソースの再利用可能オブジェクトで共有される安定したフィールド。

バッチフィールド23件
cancelled_atinteger | null
任意

バッチがキャンセルされたUnixタイムスタンプ。

cancelling_atinteger | null
任意

キャンセルが開始されたUnixタイムスタンプ。

completed_atinteger | null
任意

バッチが完了したUnixタイムスタンプ。

completion_windowstring
必須

バッチの完了ウィンドウ。

created_atinteger
必須

バッチが作成されたUnixタイムスタンプ。

endpointstring
必須

バッチで処理されるモデレーションエンドポイント。

error_file_idstring | null
任意

RunAPIのエラーファイルID

errorsobject | null
任意

バッチの検証または実行エラー

expired_atinteger | null
任意

バッチが期限切れになったUnixタイムスタンプ。

expires_atinteger | null
任意

バッチが期限切れになるUnixタイムスタンプ。

failed_atinteger | null
任意

バッチが失敗したUnixタイムスタンプ。

finalizing_atinteger | null
任意

バッチが最終化フェーズに入ったUnixタイムスタンプ。

idstring
必須

RunAPIのバッチID。

in_progress_atinteger | null
任意

バッチ処理が開始されたUnixタイムスタンプ。

input_file_idstring
必須

RunAPIの入力ファイルID。

metadataobject
必須

バッチとともに返される呼び出し元メタデータ。

objectstring
必須

オブジェクトタイプ。

output_file_idstring | null
任意

RunAPIの出力ファイルID

request_countsobject
必須
request_counts.completedinteger
必須
request_counts.failedinteger
必須
request_counts.totalinteger
必須
statusstring
必須

バッチのライフサイクルステータス。

許可される値: validating, failed, in_progress, finalizing, completed, expired, cancelling, cancelled