Method: history.lookup

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

طلب HTTP

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

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

نص الطلب

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

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

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

enum (ExtraComputation)

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

enum (ColorPalette)

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

object (CustomLocalAqi)

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

string (Timestamp format)

طابع زمني يتم عرض البيانات السابقة له. ويتم تقريب الطابع الزمني إلى الساعة السابقة بالضبط.

ملاحظة: سيؤدي هذا الإجراء إلى عرض بيانات كل ساعة للطابع الزمني المطلوب فقط (أي عنصر معلومات واحد كل ساعة). على سبيل المثال، سيتم تقريب الطلب الذي يتم إرساله مع ضبط مَعلمة dateTime على 2023-01-03T11:05:49Z إلى 2023-01-03T11:00:00Z.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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.
languageCode

string

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

نص الاستجابة

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

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

object (HourInfo)

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

string

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

string

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

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

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

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

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

HourInfo

تعرض معلومات حول جودة الهواء لكل ساعة في النطاق المطلوب. على سبيل المثال، إذا كان الطلب متعلقًا بسجلّ 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 على true.
  • مؤشر جودة الهواء المحلي. سيتم عرضه إذا تم تحديد طريقة الاحتساب الإضافية لـ LOCAL_AQI.
pollutants[]

object (Pollutant)

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

object (HealthRecommendations)

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