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