Method: currentConditions.lookup

נקודת הקצה לתנאים הנוכחיים מספקת מידע שעתי על איכות האוויר ביותר מ-100 מדינות, ברזולוציה של עד 500x500 מטר. הנתונים כוללים יותר מ-70 מדדים מקומיים, מדד גלובלי של איכות אוויר וקטגוריות.

בקשת HTTP

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

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

גוף הבקשה

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

ייצוג JSON 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "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 של ארה"ב לקנדה, במקום את מדד ברירת המחדל לקנדה.
universalAqi

boolean

זה שינוי אופציונלי. אם המדיניות מוגדרת כ-True, מדד ה-AQI האוניברסלי ייכלל במדדים 'אינדקסים' בשדה של התשובה. ערך ברירת המחדל הוא True.
languageCode

string

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

גוף התשובה

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

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

string (Timestamp format)

חותמת זמן מעוגלת כלפי מטה ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. לדוגמה: '2014-10-02T15:00:00Z'.
regionCode

string

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

object (AirQualityIndex)

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

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

object (Pollutant)

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

object (HealthRecommendations)

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

היקפי ההרשאות

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

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

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