/api/v4/locations/photos/requests/{requestId}写真の一括アップロード状況を確認する
写真の一括アップロードリクエストの現在の処理状況を返します。
パラメーター
パス
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| requestId | string | 必須 | UUID request ID returned in the `request` object by the add-photos endpoint when it queues a batch instead of uploading it inline. |
レスポンス
200Current status of the bulk upload request, with per-photo results once available.
{ "data": { "getLocationPhotosUploadStatus": { "requestId": "e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a", "status": "SUCCESS", "photos": [ { "mediaId": "TWVkaWFGaWxlOjkxODI3", "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "status": "SUCCESS", "errorMessage": null }, { "mediaId": null, "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "status": "ERROR", "errorMessage": "Image dimensions below the minimum 250x250." } ] } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
非同期で実行される写真の一括アップロードの状況をポーリングします。バッチが一定以上のサイズになると、拠点の写真を追加はバックグラウンドで処理を実行し、処理済みのメディアの代わりに、requestオブジェクト内にrequestIdを返します。この動作を引き起こすバッチサイズは、公開された定数ではなくサーバー側の設定で決まるため、画像の枚数を自分で数えるのではなく、request.requestIdが返されたかどうかを確認して処理方式を判断してください。そのrequestIdを使い、ジョブが終了するまでこのエンドポイントをポーリングしてください。
ユースケース:アップロードの進行状況バーを更新する。 大きなバッチをアップロードした後は、statusがPROCESSINGである間、数秒ごとにポーリングしてください。SUCCESSまたはERRORに変わったら、photos配列で画像ごとの結果を確認してください。各エントリには、結果のmediaId(成功時)とstatus/errorMessageのペアが含まれるため、バッチ全体を失敗として扱うのではなく、どのファイルが拒否されたかと、その理由(寸法の不一致、非対応の形式など)を正確に表示できます。
ステータス値: PROCESSING(処理中:再度ポーリングしてください)、SUCCESS(ジョブの処理が完了しました)、ERROR(ジョブ自体が失敗しました。photos[].errorMessageを確認してください)。
ジョブのstatusが示すのは処理の完了だけであり、すべての画像の処理が成功したことではありません。上のサンプルのように、SUCCESSのジョブにも拒否された写真が含まれている場合があります。ジョブがPROCESSINGでなくなったら、photos[]を順に確認し、各エントリのstatusとerrorMessageを読み取って、どの画像が正常に追加されたかを確認してください。
ポーリングの注意点: ポーリングの間には待機時間を設けてください。このエンドポイントに対して短い間隔でループを実行すると、すぐに429が返されます。Retry-Afterヘッダーに従い、数秒の間隔を設けることを推奨します。不明または期限切れのrequestIdでは結果を取得できないため、直近のアップロード呼び出しで返されたIDのみをポーリングしてください。
curl -X GET 'https://listingsapi.com/api/v4/locations/photos/requests/<requestId>' \ -H "Authorization: API $LISTINGSAPI_KEY"