產生新影片

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