Method: currentConditions.lookup

توفّر نقطة نهاية "الظروف الحالية" معلومات عن جودة الهواء كل ساعة في أكثر من 100 بلد بدقة تصل إلى 500 × 500 متر. تتضمّن أكثر من 70 مؤشرًا محليًا ومؤشر جودة الهواء العالمي وفئاتها.

طلب HTTP

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

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

نص الطلب

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

تمثيل JSON 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "universalAqi": boolean,
  "languageCode": string
}
الحقول
location

object (LatLng)

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

enum (ExtraComputation)

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

enum (ColorPalette)

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

object (CustomLocalAqi)

اختياريّ. يعبّر عن العلاقة بين "البلد/المنطقة" و"مؤشر جودة الهواء" (AQI). يؤدي هذا الخيار إلى إقران بلد أو منطقة بمؤشر جودة الهواء المطلوب لكي يتم عرض بيانات جودة الهواء المطلوبة لهذا البلد أو المنطقة وفقًا لمؤشر جودة الهواء الذي تم اختياره. يمكن استخدام هذه المَعلمة لتحديد مؤشر جودة الهواء غير التلقائي لبلد معيّن، مثلاً للحصول على مؤشر وكالة حماية البيئة الأمريكية (EPA) لكندا بدلاً من الفهرس التلقائي لكندا.
universalAqi

boolean

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

string

اختياريّ. تسمح للعميل باختيار لغة الرد. إذا تعذّر تقديم بيانات لتلك اللغة، ستستخدم واجهة برمجة التطبيقات أقرب محتوى مطابق. تعتمد القيم المسموح بها على معيار مجموعة مهندسي شبكة الإنترنت (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 alpha-2 للبلد/المنطقة المتوافقة مع الموقع الجغرافي المقدَّم في الطلب. قد يتم حذف هذا الحقل من الردّ إذا كان الموقع الجغرافي المقدَّم في الطلب يقع في منطقة متنازع عليها.
indexes[]

object (AirQualityIndex)

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

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

object (Pollutant)

قائمة بالملوّثات التي تؤثر في الموقع الجغرافي المحدّد في الطلب ملاحظة: سيتم عرض هذا الحقل فقط للطلبات التي حددت واحدة أو أكثر من العمليات الإضافية التالية: POLLUTANT_ADDITIONAL_INFO وDOINANT_POLLUTANT_CONCENTRATION وPOLLUTANT_CONCENTRATION.
healthRecommendations

object (HealthRecommendations)

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

نطاقات التفويض

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

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

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