Method: forecast.lookup

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

درخواست HTTP

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

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

درخواست بدن

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

نمایندگی JSON 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "pageSize": integer,
  "pageToken": string,
  "dateTime": string,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "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 ایالات متحده برای کانادا به جای شاخص پیش فرض برای کانادا.

pageSize

integer

اختیاری. حداکثر تعداد رکوردهای اطلاعات ساعتی برای بازگشت در هر صفحه (پیش فرض = 24).

pageToken

string

اختیاری. نشانه صفحه دریافت شده از تماس پیش بینی قبلی. برای بازیابی صفحه بعدی استفاده می شود.

dateTime

string ( Timestamp format)

مهر زمانی که برای بازگرداندن داده ها برای یک نقطه خاص در زمان است. مهر زمانی به ساعت دقیق قبلی گرد می شود.

این داده‌های ساعتی را فقط برای مهر زمانی درخواستی (یعنی یک عنصر اطلاعات ساعتی) برمی‌گرداند. به عنوان مثال، درخواست ارسال شده در جایی که پارامتر dateTime روی 2023-01-03T11:05:49Z تنظیم شده است به 2023-01-03T11:00:00Z گرد می شود.

توجه: در یک درخواست می توان dateTime یا startTime و endTime استفاده کرد.

period

object ( Interval )

دوره startTime و endTime را برای دریافت داده های پیش بینی نشان می دهد. endTime شامل است. مهر زمانی به ساعت دقیق قبلی گرد می شود.

توجه: در یک درخواست می توان dateTime یا startTime و endTime استفاده کرد.

universalAqi

boolean

اختیاری. اگر روی درست تنظیم شود، AQI جهانی در قسمت «شاخص‌ها» پاسخ (پیش‌فرض = درست) گنجانده می‌شود.

languageCode

string

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

بدن پاسخگو

هدف پاسخ API پیش‌بینی کیفیت هوا.

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

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

object ( HourlyForecast )

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

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