יצירת סרטון חדש

השיטה 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.

כדי לבצע שאילתת Poll, שולחים בקשה אל lookupVideo עם videoId. תהליך הרינדור יכול להימשך כמה שעות, לכן מומלץ להשתמש בהשהיה מעריכית לפני ניסיון חוזר (exponential backoff) כדי להרווח בין הקריאות.

תגובה פעילה

אם הפונקציה renderVideo מחזירה את הערך state שהוא ACTIVE, זה אומר שהסרטון סיים את העיבוד ואפשר לאחזר אותו באמצעות קריאה לפונקציה lookupVideo עם הערך videoId.

{
  "state": "ACTIVE",
  "metadata": {
    "videoId": "x89iJAJi1wzs7DIAFQF7Va"
  }
}