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

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