Method: forecast.lookup

تعرض توقّعات جودة الهواء في موقع جغرافي معيّن لنطاق زمني محدّد.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل 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)

مطلوب. خطوط الطول والعرض اللتان تبحث عنهما واجهة برمجة التطبيقات عن بيانات جودة الهواء
extraComputations[]

enum (ExtraComputation)

اختياريّ. الميزات الإضافية التي يمكن تفعيلها اختياريًا. سيؤدي تحديد عمليات حسابية إضافية إلى عرض العناصر والحقول ذات الصلة في الردّ.
uaqiColorPalette

enum (ColorPalette)

اختياريّ. لتحديد لوحة الألوان المستخدمة للبيانات التي يوفّرها "مؤشر جودة الهواء العالمي" (UAQI). تلائم لوحة الألوان هذه مؤشر UAQI فقط، بينما تتضمّن مؤشرات جودة الهواء الأخرى لوحة ألوان محدّدة مسبقًا لا يمكن التحكّم فيها.
customLocalAqis[]

object (CustomLocalAqi)

اختياريّ. تعبِّر عن "البلد/المنطقة المرتبطة بمؤشر جودة الهواء (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

اختياريّ. في حال ضبط هذه السياسة على "صحيح"، سيتم تضمين مؤشر جودة الهواء العام في "المؤشرات". حقل الاستجابة (الافتراضي = true).
languageCode

string

اختياريّ. تسمح للعميل باختيار لغة الرد. إذا تعذّر توفير بيانات لهذه اللغة، ستستخدم واجهة برمجة التطبيقات أقرب تطابق. تعتمد القيم المسموح بها على معيار IETF (القيمة التلقائية = 'en').

نص الاستجابة

كائن الاستجابة في واجهة برمجة التطبيقات لتوقّعات جودة الهواء

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
الحقول
hourlyForecasts[]

object (HourlyForecast)

اختياريّ. تعرض معلومات حول جودة الهواء لكل ساعة في النطاق المطلوب. على سبيل المثال، إذا كان الطلب لمدة 48 ساعة من التوقعات، سيكون هناك 48 عنصرًا من التوقعات كل ساعة.
regionCode

string

اختياريّ. تمثّل هذه السمة رمز ISO_3166-1 alpha-2 للبلد أو المنطقة المتوافقَين مع الموقع الجغرافي المقدَّم في الطلب. قد يتم حذف هذا الحقل من الرد إذا كان الموقع الجغرافي المذكور في الطلب يقع في منطقة متنازع عليها.
nextPageToken

string

اختياريّ. الرمز المميّز لاسترداد الصفحة التالية.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطِّلاع على نظرة عامة على OAuth 2.0.

HourlyForecast

تعرض معلومات حول جودة الهواء لكل ساعة في النطاق المطلوب. على سبيل المثال، إذا كان الطلب لمدة 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)

استنادًا إلى معلَمات الطلب، تتضمّن هذه القائمة (ما يصل إلى) مؤشرَين لجودة الهواء:

  • مؤشر جودة الهواء العام. سيتم عرضه إذا تم ضبط القيمة المنطقية universalAqi على "صحيح".
  • مؤشر جودة الهواء المحلي. سيتم عرضه إذا تم تحديد طريقة الاحتساب الإضافية لـ LOCAL_AQI.
pollutants[]

object (Pollutant)

تعرض هذه السياسة قائمة بالملوّثات التي تؤثّر في الموقع الجغرافي المحدّد في الطلب.

ملاحظة: لن يتم عرض هذا الحقل إلا للطلبات التي حددت واحدة أو أكثر من العمليات الحسابية الإضافية التالية: POLLUTANT_ADDITIONAL_INFO وDOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
healthRecommendations

object (HealthRecommendations)

النصائح الصحية والإجراءات المقترَحة المتعلقة بظروف جودة الهواء التي يتم الإبلاغ عنها يتم تصميم الاقتراحات بشكل مختلف حسب الفئات السكانية المعرّضة للخطر والمجموعات ذات الحساسية الأكبر للملوّثات وعموم السكان.