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