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

השיטה 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?X-Goog-Api-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?X-Goog-Api-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 מחזירה ערך state של ACTIVE, זה אומר שהסרטון סיים את הרינדור ואפשר לאחזר אותו על ידי קריאה ל-lookupVideo עם videoId.

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