التاريخ

توفّر نقطة النهاية history معلومات سابقة عن جودة الهواء في كل ساعة لموقع جغرافي معيّن، وذلك لنطاق زمني محدّد يصل إلى 30 يومًا كحدّ أقصى. يمكنك التحكّم في مؤشرات جودة الهواء والمعلومات ذات الصلة التي يتم عرضها (مثل مستوى تركيز الملوّثات والنصائح الصحية).

يمكنك طلب سجلّ جودة الهواء لكل ساعة باستخدام نقطة النهاية history من خلال إرسال طلب POST إلى:

https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY

أدرِج خيارات الطلب في نص طلب JSON. يحتوي نص الطلب على الموقع الجغرافي والنطاق الزمني اللذين تريد الحصول على سجلّ جودة الهواء فيهما بالساعة. وقد يتضمّن أيضًا خيارات متنوّعة للتحكّم في معلومات جودة الهواء التي يجب تضمينها في الردّ.

تتيح لك أداة "مستكشف واجهات برمجة التطبيقات" إجراء طلبات مباشرة حتى تتمكّن من التعرّف على واجهة برمجة التطبيقات وخياراتها:

مثال على طلب ساعة واحدة

نص الطلب لساعة واحدة

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

curl -X POST -d '{
  "dateTime": "2023-06-26T15:01:23Z",
  "location": {
    "latitude": 37.419734,
    "longitude": -122.0827784
  }
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'

الردّ خلال ساعة واحدة

يؤدي الطلب أعلاه إلى إنشاء استجابة JSON التالية. لمزيد من التفاصيل حول بيانات الردود، يُرجى الاطّلاع على بيانات الردود.

{
    "hoursInfo": [
        {
            "dateTime": "2023-06-26T15:00:00Z",
            "indexes": [
                {
                    "code": "uaqi",
                    "displayName": "Universal AQI",
                    "aqi": 73,
                    "aqiDisplay": "73",
                    "color": {
                        "red": 118,
                        "green": 202,
                        "blue": 51,
                        "alpha": 255
                    },
                    "category": "Good air quality",
                    "dominantPollutant": "pm10"
                }
            ]
        }
    ],
    "regionCode": "us"
}

مثال على طلب نطاق زمني

طلب نطاق زمني

يوضّح الرمز التالي كيفية إنشاء نص طلب لـ history الذي يعرض سجلات متعددة لجودة الهواء في الساعة السابقة.

يمكنك طلب سجلات متعددة عن طريق تحديد نطاق زمني، أي طابع زمني للبدء والانتهاء، أو عن طريق تحديد عدد الساعات السابقة من الوقت الحالي.

في المثال أدناه، بما أنّك ضبطت حجم الصفحة على 2، سيتم عرض طلبك للحصول على سجلّ جودة الهواء لمدة أربع ساعات في صفحتَين، حيث تحتوي كل صفحة على بيانات لمدة ساعتَين.

curl -X POST -d '{
  "hours": 4,
  "pageSize": 2,
  "pageToken":"",
  "location": {
    "latitude": 37.419734,
    "longitude": -122.0827784
  }
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'

يمكنك تقديم طلب مشابه من خلال تمرير الطابعين الزمنيين للبدء والانتهاء:

curl -X POST -d '{
  "period": {
      "startTime":"2023-06-15T08:00:00Z",
      "endTime":"2023-06-15T12:00:00Z"
  },
  "pageSize": 2,
  "pageToken":"",
  "location": {
    "latitude": 37.419734,
    "longitude": -122.0827784
  }
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'

ردّ بشأن نطاق زمني

تؤدي الطلبات أعلاه إلى إنشاء ردّ JSON بالشكل أدناه. لمزيد من التفاصيل حول بيانات الاستجابة، يُرجى الاطّلاع على بيانات الاستجابة.

يطلب كلا الطلبَين أعلاه بيانات جودة الهواء لمدة أربع ساعات. ومع ذلك، نظرًا لأنك قمت بتعيين الخاصية pageSize على 2 في الطلب، فإن الاستجابة تتضمن فقط نتائج آخر ساعتين.

{
    "hoursInfo": [
        {
            "dateTime": "2023-06-15T11:00:00Z",
            "indexes": [
                {
                    "code": "uaqi",
                    "displayName": "Universal AQI",
                    "aqi": 83,
                    "aqiDisplay": "83",
                    "color": {
                        "red": 74,
                        "green": 185,
                        "blue": 54,
                        "alpha": 255
                    },
                    "category": "Excellent air quality",
                    "dominantPollutant": "o3"
                }
            ]
        },
        {
            "dateTime": "2023-06-15T10:00:00Z",
            "indexes": [
                {
                    "code": "uaqi",
                    "displayName": "Universal AQI",
                    "aqi": 89,
                    "aqiDisplay": "89",
                    "color": {
                        "red": 48,
                        "green": 175,
                        "blue": 55,
                        "alpha": 255
                    },
                    "category": "Excellent air quality",
                    "dominantPollutant": "o3"
                }
            ]
        }
    ],
    "regionCode": "us",
    "nextPageToken": "ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA"
}

يُرجى العِلم أنّ الردّ يتضمّن أيضًا السمة nextPageToken. استخدِم هذه السمة للوصول إلى الصفحة التالية من النتائج التي تحتوي على بيانات الساعتَين التاليتَين.

للوصول إلى الصفحة التالية من النتائج، أرسِل طلبًا ثانيًا إلى نقطة النهاية history، ولكن هذه المرة اضبط السمة pageToken على قيمة nextPageToken من الردّ الأول.

curl -X POST -d '{
  "hours": 4,
  "pageSize": 2,
  "pageToken":"ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA",
  "location": {
    "latitude": 37.419734,
    "longitude": -122.0827784
  }
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'

جرِّبها الآن.

يتيح لك "مستكشف واجهات برمجة التطبيقات" إرسال نماذج طلبات لكي تتمكّن من التعرّف على واجهة برمجة التطبيقات وخياراتها.

  1. انقر على رمز واجهة برمجة التطبيقات api على يسار الصفحة.

  2. يمكنك تعديل مَعلمات الطلب إذا أردت.

  3. انقر على الزر تنفيذ. في مربّع الحوار، اختَر الحساب الذي تريد استخدامه لتقديم الطلب.

  4. في لوحة "مستكشف واجهات برمجة التطبيقات"، انقر على رمز ملء الشاشة ملء الشاشة لتوسيع نافذة "مستكشف واجهات برمجة التطبيقات".