Method: forecast.lookup

מחזירה תחזית של איכות האוויר במיקום ספציפי בטווח זמן נתון.

בקשת HTTP

POST https://airquality.googleapis.com/v1/forecast:lookup

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "pageSize": integer,
  "pageToken": string,
  "dateTime": string,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
שדות
location

object (LatLng)

חובה. קווי האורך והרוחב שעבורם מתבצע חיפוש של נתוני איכות האוויר על ידי ה-API.
extraComputations[]

enum (ExtraComputation)

זה שינוי אופציונלי. תכונות נוספות שאפשר להפעיל. ציון חישובים נוספים יגרום להחזרת הרכיבים והשדות הרלוונטיים בתגובה.
uaqiColorPalette

enum (ColorPalette)

זה שינוי אופציונלי. ההגדרה הזו קובעת את לוח הצבעים של הנתונים שמצוינים ב 'מדד איכות האוויר האוניברסלי' (UAQI). לוח הצבעים הזה רלוונטי רק ל-UAQI, ל-AQI אחרים יש לוח צבעים קבוע מראש שאי אפשר לשלוט בו.
customLocalAqis[]

object (CustomLocalAqi)

זה שינוי אופציונלי. מבטא את הקשר 'מדינה/אזור ל-AQI'. התאמה של מדינה/אזור עם AQI רצוי כדי שנתוני איכות האוויר הנדרשים למדינה או לאזור האלה יוצגו בהתאם ל-AQI שנבחר. אפשר להשתמש בפרמטר הזה כדי לציין AQI שלא מוגדר כברירת מחדל עבור מדינה מסוימת. לדוגמה, כדי לקבל את מדד EPA של קנדה במקום את אינדקס ברירת המחדל עבור קנדה.
pageSize

integer

זה שינוי אופציונלי. המספר המרבי של רשומות מידע שעתיות שיש להחזיר בכל דף (ברירת מחדל = 24).
pageToken

string

זה שינוי אופציונלי. אסימון דף שהתקבל מקריאה קודמת של תחזית. הוא משמש לאחזור הדף הבא.
dateTime

string (Timestamp format)

חותמת זמן שעבורה יש להחזיר את הנתונים עבור נקודת זמן ספציפית. חותמת הזמן מעוגלת לשעה הקודמת בדיוק.

הפעולה הזו תחזיר נתונים שעתיים עבור חותמת הזמן המבוקשת בלבד (כלומר, רכיב מידע יחיד לפי שעה). לדוגמה, בקשה שנשלחת שבה הפרמטר dateTime מוגדר כ-2023-01-03T11:05:49Z תעוגל למטה ל-2023-01-03T11:00:00Z.

הערה: בקשה יכולה לכלול dateTime או startTime וגם endTime.
period

object (Interval)

מציין את התקופות startTime ו-endTime שעבורן יתקבלו נתוני התחזית. endTime מעודד את קבלת האחר. חותמת הזמן מעוגלת לשעה הקודמת בדיוק.

הערה: בקשה יכולה לכלול dateTime או startTime וגם endTime.
universalAqi

boolean

זה שינוי אופציונלי. אם היא מוגדרת כ-True, ה-AQI האוניברסלי ייכלל בשדה 'indexes' של התשובה (ברירת המחדל = true).
languageCode

string

זה שינוי אופציונלי. מאפשר ללקוח לבחור את השפה לתגובה. אם לא ניתן לספק נתונים לשפה הזו, ה-API ישתמש בהתאמה הקרובה ביותר. הערכים המותרים מבוססים על תקן IETF (ברירת המחדל היא 'en').

גוף התשובה

אובייקט התגובה של ממשק ה-API של תחזית איכות האוויר.

אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
שדות
hourlyForecasts[]

object (HourlyForecast)

זה שינוי אופציונלי. מכילה את המידע על איכות האוויר לכל שעה בטווח המבוקש. לדוגמה, אם הבקשה היא לתחזית של 48 שעות, יהיו 48 רכיבים של תחזיות לפי שעה.
regionCode

string

זה שינוי אופציונלי. קוד ISO_3166-1 alpha-2 של המדינה/האזור התואמים למיקום שצוין בבקשה. יכול להיות שהשדה הזה יושמט מהתשובה אם המיקום שצוין בבקשה נמצא באזור מחלוקת.
nextPageToken

string

זה שינוי אופציונלי. האסימון לאחזור הדף הבא.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.

HourlyForecast

מכילה את המידע על איכות האוויר לכל שעה בטווח המבוקש. לדוגמה, אם הבקשה היא לתחזית של 48 שעות, יהיו 48 רכיבים של תחזיות לפי שעה.

ייצוג JSON 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
שדות
dateTime

string (Timestamp format)

חותמת זמן מעוגלת כלפי מטה, שמציינת את השעה (שעה) שאליה הנתונים מתייחסים בפורמט 'זולו' RFC3339 UTC. לדוגמה: 2014-10-02T15:00:00Z.
indexes[]

object (AirQualityIndex)

רשימה זו תכלול (עד) שני מדדים של איכות האוויר, על סמך הפרמטרים של הבקשות:

  • AQI אוניברסלי. הפונקציה תחזיר אם הערך הבוליאני universalAqi יוגדר כ-true.
  • AQI מקומי. הפונקציה תוחזר אם צוין החישוב הנוסף LOCAL_AQI.
pollutants[]

object (Pollutant)

רשימה של מזהמים שמשפיעים על המיקום שצוין בבקשה.

הערה: השדה הזה יוחזר רק עבור בקשות שצוינו אחד או יותר מהחישובים הנוספים הבאים: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
healthRecommendations

object (HealthRecommendations)

עצות בריאותיות ופעולות מומלצות הקשורות לתנאי איכות האוויר שדווחו. ההמלצות מותאמות באופן שונה לאוכלוסיות בסיכון, לקבוצות עם רגישות גבוהה יותר למזהמים ולאוכלוסייה הכללית.