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
返回的 state
值为 ACTIVE
,则表示视频已呈现完毕,您可以通过使用 videoId
调用 lookupVideo
来检索该视频。
{
"state": "ACTIVE",
"metadata": {
"videoId": "x89iJAJi1wzs7DIAFQF7Va"
}
}