Method: currentConditions.lookup

نقطه پایانی Current Conditions اطلاعات ساعتی کیفیت هوا را در بیش از 100 کشور تا وضوح 500×500 متر ارائه می دهد. شامل بیش از 70 شاخص محلی و شاخص و دسته بندی جهانی کیفیت هوا است.

درخواست HTTP

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

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

درخواست بدن

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

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

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 "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. به عنوان مثال: "2014-10-02T15:00:00Z".

regionCode

string

کد ISO_3166-1 آلفا-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 مراجعه کنید.