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

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