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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. לדוגמה: '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.