renderVideo
מבקש ליצור סרטון תצוגה אווירית עבור ארה"ב שצוינה
כתובת למשלוח דואר. אם הסרטון כבר קיים בכתובת שצוינה,
מחזירה מטא-נתונים על הסרטון.
איך משתמשים ב-API?
ליצור סרטון אווירי חדש על ידי שליחת בקשת HTTPS POST
renderVideo
נקודת הקצה, העברת מפתח ה-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
. תכונת הרינדור
לוקח כמה שעות, לכן צריך להשתמש בפונקציה מעריכית
השהיה לפני ניסיון חוזר (backoff) כדי לרווח את השיחות.
תגובה פעילה
כאשר renderVideo
מחזיר ערך state
של ACTIVE
, המשמעות היא שהסרטון
הסתיימה, ואפשר לאחזר אותו על ידי קריאה ל-lookupVideo
באמצעות
videoId
{
"state": "ACTIVE",
"metadata": {
"videoId": "x89iJAJi1wzs7DIAFQF7Va"
}
}