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"
}
}