Method: history.lookup

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

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

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

نمایندگی 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 جهانی در قسمت «شاخص‌ها» پاسخ گنجانده می‌شود. مقدار پیش فرض درست است.

languageCode

string

اختیاری. به مشتری امکان می دهد زبان پاسخ را انتخاب کند. اگر داده‌ای برای آن زبان ارائه نشود، API از نزدیک‌ترین تطابق استفاده می‌کند. مقادیر مجاز بر اساس استاندارد IETF است. مقدار پیش فرض en است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "hoursInfo": [
    {
      object (HourInfo)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
فیلدها
hoursInfo[]

object ( HourInfo )

اختیاری. حاوی اطلاعات کیفیت هوا برای هر ساعت در محدوده درخواستی است. به عنوان مثال، اگر درخواست برای 48 ساعت سابقه باشد، 48 عنصر اطلاعات ساعتی وجود خواهد داشت.

regionCode

string

اختیاری. کد ISO_3166-1 آلفا-2 کشور/منطقه مربوط به مکان ارائه شده در درخواست. اگر مکان ارائه شده در درخواست در یک منطقه مورد مناقشه قرار داشته باشد، ممکن است این قسمت از پاسخ حذف شود.

nextPageToken

string

اختیاری. نشانه برای بازیابی صفحه بعدی.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

اطلاعات ساعت

حاوی اطلاعات کیفیت هوا برای هر ساعت در محدوده درخواستی است. به عنوان مثال، اگر درخواست برای 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 )

توصیه های بهداشتی و اقدامات توصیه شده مربوط به شرایط کیفیت هوای گزارش شده. توصیه‌ها برای جمعیت‌های در معرض خطر، گروه‌هایی که حساسیت بیشتری نسبت به آلاینده‌ها دارند و جمعیت عمومی متفاوت است.