این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

تاریخ

نقطه پایانی history اطلاعات ساعتی تاریخی کیفیت هوا را برای یک مکان خاص، برای یک محدوده زمانی معین، حداکثر تا 30 روز ارائه می دهد. می توانید AQI و اطلاعات مربوطه را که بازگردانده می شوند (مانند سطح غلظت آلاینده ها و توصیه های بهداشتی) کنترل کنید.

با ارسال یک درخواست HTTP POST می توانید تاریخچه کیفیت هوای ساعتی را با استفاده از نقطه پایانی history درخواست کنید:

https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY

گزینه های درخواست خود را در بدنه درخواست JSON قرار دهید. بدنه درخواست شامل مکان و محدوده زمانی است که می‌خواهید تاریخچه ساعتی کیفیت هوا را دریافت کنید. همچنین ممکن است شامل گزینه های مختلفی برای کنترل اطلاعات کیفیت هوا در پاسخ باشد.

نمونه ای از درخواست یک ساعته

بدن درخواست یک ساعته

کد زیر نحوه ساخت بدنه درخواست برای یک درخواست تاریخچه یک ساعته را با استفاده از روش history نشان می دهد. در این مثال، مکان و زمان گذشته را تنظیم می کنید.

curl -X POST -d '{
  "dateTime": "2023-06-26T15:01:23Z",
  "location": {
    "latitude": 37.419734,
    "longitude": -122.0827784
  }
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'

پاسخگویی یک ساعته

تماس بالا پاسخ JSON زیر را ایجاد می کند. برای جزئیات بیشتر درباره داده‌های پاسخ، به داده‌های پاسخ مراجعه کنید.

{
    "hoursInfo": [
        {
            "dateTime": "2023-06-26T15:00:00Z",
            "indexes": [
                {
                    "code": "uaqi",
                    "displayName": "Universal AQI",
                    "aqi": 73,
                    "aqiDisplay": "73",
                    "color": {
                        "red": 118,
                        "green": 202,
                        "blue": 51,
                        "alpha": 255
                    },
                    "category": "Good air quality",
                    "dominantPollutant": "pm10"
                }
            ]
        }
    ],
    "regionCode": "us"
}

نمونه درخواست محدوده زمانی

درخواست محدوده زمانی

کد زیر نحوه ساخت بدنه درخواستی برای history را نشان می دهد که چندین رکورد از کیفیت هوای ساعتی تاریخی را برمی گرداند.

شما می توانید با تعیین یک بازه زمانی، به معنی مهر زمانی شروع و پایان، یا با تعیین تعداد ساعات برگشت از زمان فعلی، چندین رکورد را درخواست کنید.

در مثال زیر، چون اندازه صفحه را 2 تنظیم کرده اید، درخواست شما برای چهار ساعت سابقه کیفیت هوا در دو صفحه بازگردانده می شود که هر صفحه حاوی دو ساعت داده است.

curl -X POST -d '{
  "hours": 4,
  "pageSize": 2,
  "pageToken":"",
  "location": {
    "latitude": 37.419734,
    "longitude": -122.0827784
  }
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'

شما می توانید با عبور از مهرهای زمانی شروع و پایان، درخواست مشابهی ارائه دهید:

curl -X POST -d '{
  "period": {
      "startTime":"2023-06-15T08:00:00Z",
      "endTime":"2023-06-15T12:00:00Z"
  },
  "pageSize": 2,
  "pageToken":"",
  "location": {
    "latitude": 37.419734,
    "longitude": -122.0827784
  }
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'

پاسخ محدوده زمانی

تماس های بالا یک پاسخ JSON به شکل زیر ایجاد می کنند. برای جزئیات بیشتر درباره داده‌های پاسخ، به داده‌های پاسخ مراجعه کنید.

هر دو تماس فوق چهار ساعت داده کیفیت هوا را درخواست می کنند. با این حال، از آنجایی که ویژگی pageSize در درخواست روی 2 تنظیم کرده اید، پاسخ فقط شامل نتایج دو ساعت اخیر می شود.

{
    "hoursInfo": [
        {
            "dateTime": "2023-06-15T11:00:00Z",
            "indexes": [
                {
                    "code": "uaqi",
                    "displayName": "Universal AQI",
                    "aqi": 83,
                    "aqiDisplay": "83",
                    "color": {
                        "red": 74,
                        "green": 185,
                        "blue": 54,
                        "alpha": 255
                    },
                    "category": "Excellent air quality",
                    "dominantPollutant": "o3"
                }
            ]
        },
        {
            "dateTime": "2023-06-15T10:00:00Z",
            "indexes": [
                {
                    "code": "uaqi",
                    "displayName": "Universal AQI",
                    "aqi": 89,
                    "aqiDisplay": "89",
                    "color": {
                        "red": 48,
                        "green": 175,
                        "blue": 55,
                        "alpha": 255
                    },
                    "category": "Excellent air quality",
                    "dominantPollutant": "o3"
                }
            ]
        }
    ],
    "regionCode": "us",
    "nextPageToken": "ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA"
}

توجه داشته باشید که پاسخ شامل ویژگی nextPageToken نیز می شود. از این ویژگی برای دسترسی به صفحه بعدی نتایج که حاوی داده های دو ساعت بعدی است استفاده کنید.

برای دسترسی به صفحه بعدی نتایج، یک درخواست دوم به نقطه پایانی history ارائه دهید، اما این بار ویژگی pageToken را با مقدار nextPageToken از اولین پاسخ تنظیم کنید.

curl -X POST -d '{
  "hours": 4,
  "pageSize": 2,
  "pageToken":"ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA",
  "location": {
    "latitude": 37.419734,
    "longitude": -122.0827784
  }
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'