renderVideo
メソッドは、指定された米国の郵便番号の航空写真動画の生成をリクエストします。指定されたアドレスの動画がすでに存在する場合、このメソッドは動画に関するメタデータを返します。
API の使用にあたっての注意事項
次の例に示すように、renderVideo
エンドポイントに HTTPS POST リクエストを行い、API Key と米国の郵便番号を渡して、新しい空中動画を生成します。レンダリング処理には 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
が ACTIVE
の state
値を返した場合、動画のレンダリングが完了したことを意味します。この動画は、videoId
を使用して lookupVideo
を呼び出すことで取得できます。
{
"state": "ACTIVE",
"metadata": {
"videoId": "x89iJAJi1wzs7DIAFQF7Va"
}
}