renderVideo
メソッドは、指定された米国の郵便番号の航空写真動画の生成をリクエストします。指定されたアドレスの動画がすでに存在する場合、このメソッドは動画のメタデータを返します。
API の使用にあたっての注意事項
次の例に示すように、renderVideo
エンドポイントに HTTPS POST リクエストを送信し、API キーと米国の郵便番号を渡して、新しい空撮動画を生成します。レンダリング処理には 1 時間から数時間かかることがあります。
curl -X POST -d '{ "address": "POSTAL_ADDRESS" }' \ -H 'Content-Type: application/json' \ "https://aerialview.googleapis.com/v1/videos:renderVideo?key=YOUR_API_KEY"
リクエスト例
次のコード例では、500 W 2nd St, Austin, TX, 78701 の空撮動画の生成をリクエストしています。
curl -X POST -d '{ "address": "500 W 2nd St, Austin, TX 78701" }' \ -H 'Content-Type: application/json' \ "https://aerialview.googleapis.com/v1/videos:renderVideo?key=YOUR_API_KEY"
レスポンスの例
次の JSON コードサンプルは、動画リクエストの例に対するレスポンスの例を示しています。
無効な住所レスポンス
住所が間違っているか、米国内の住所ではありません。
{
"error": {
"code": 400,
"message": "Address not supported.",
"status": "INVALID_ARGUMENT"
}
}
レスポンスの処理
Aerial View API で動画のレンダリングが開始されます。レスポンスには、動画の取得に使用できる videoId
が含まれています。
{
"state": "PROCESSING",
"metadata": {
"videoId": "x89iJAJi1wzs7DIAFQF7Va"
}
}
レンダリング処理には 1 時間から数時間かかることがあります。動画がまだ処理中の場合は、lookupVideo
を使用して、状態が ACTIVE
になるまで動画のステータスをポーリングできます。
ポーリングするには、videoId
を渡して lookupVideo
にリクエストを送信します。レンダリングには数時間かかることがあるため、指数バックオフを使用して呼び出しの間隔を空けてください。
アクティブな対応
renderVideo
が state
値 ACTIVE
を返した場合、動画のレンダリングが完了したことを意味します。videoId
を使用して lookupVideo
を呼び出すことで、動画を取得できます。
{
"state": "ACTIVE",
"metadata": {
"videoId": "x89iJAJi1wzs7DIAFQF7Va"
}
}