Method: history.lookup

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

בקשת HTTP

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

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

גוף הבקשה

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

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

integer

זה שינוי אופציונלי. המספר המקסימלי של רשומות מידע שעתיות שיש להחזיר בכל דף. ברירת המחדל היא 72 והערך המקסימלי הוא 168 (נתונים של 7 ימים).
pageToken

string

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

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

object (LatLng)

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

enum (ExtraComputation)

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

enum (ColorPalette)

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

object (CustomLocalAqi)

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

string (Timestamp format)

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

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

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: 2014-10-02T15:01:23Z ו-2014-10-02T15:01:23.045123456Z.

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

integer

מספר בין 1 ל-720 שמציין את טווח השעות של הבקשה. לדוגמה: ערך של 48 יניב נתונים מ-48 השעות האחרונות.
period

object (Interval)

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

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

boolean

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

string

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

גוף התשובה

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

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

object (HourInfo)

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

string

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

string

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

היקפי הרשאות

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

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

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

HourInfo

מכילה את המידע על איכות האוויר לכל שעה בטווח המבוקש. לדוגמה, אם הבקשה היא היסטוריה של 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)

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