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 號 (郵遞區號 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
值時,表示影片已完成算繪,您可以透過呼叫 lookupVideo
並使用 videoId
擷取影片。
{
"state": "ACTIVE",
"metadata": {
"videoId": "x89iJAJi1wzs7DIAFQF7Va"
}
}