renderVideo
方法请求为指定的美国邮政地址生成航拍视图视频。如果指定地址已有视频,此方法会返回有关视频的元数据。
如何使用该 API
向 renderVideo
端点发出 HTTPS POST 请求,并传递您的 API 密钥和美国邮政地址,以生成新的航拍视频,如以下示例所示。渲染过程可能需要一小时到几小时不等。
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"
}
}
渲染过程可能需要一小时到几小时不等。如果视频仍在处理中,您可以使用 lookupVideo
轮询视频状态,直到其返回 ACTIVE
状态。
如需发起轮询,请向 lookupVideo
发出请求,并传递 videoId
。渲染可能需要几个小时,因此请使用指数退避算法来间隔开调用。
主动回应
当 renderVideo
返回 ACTIVE
的 state
值时,表示视频已完成渲染,您可以使用 videoId
调用 lookupVideo
来检索该视频。
{
"state": "ACTIVE",
"metadata": {
"videoId": "x89iJAJi1wzs7DIAFQF7Va"
}
}