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

ה-method 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. העיבוד עשוי להימשך כמה שעות, לכן כדאי להשתמש בהשהיה מעריכית לפני ניסיון חוזר (exponential backoff) כדי לפנות את הקריאות.

תגובה פעילה

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

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