تقدّم نقطة النهاية history
معلومات تاريخية عن جودة الهواء كل ساعة لموقع جغرافي محدّد، وذلك لنطاق زمني معيّن، ولمدة تصل إلى 30 يومًا كحد أقصى. يمكنك التحكّم في مؤشرات جودة الهواء والمعلومات ذات الصلة التي يتم عرضها (مثل مستوى تركيز الملوّثات والتوصيات الصحية).
يمكنك طلب سجلّ بجودة الهواء كل ساعة باستخدام نقطة النهاية
history
من خلال إرسال طلب HTTP 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'
جرِّبها الآن
يتيح لك "مستكشف واجهات برمجة التطبيقات" تقديم طلبات نموذجية لتتعرّف على واجهة برمجة التطبيقات وخياراتها.
انقر على رمز واجهة برمجة التطبيقات api في يسار الصفحة.
عدِّل مَعلمات الطلب اختياريًا.
انقر على الزر تنفيذ. في مربّع الحوار، اختَر الحساب الذي تريد استخدامه لتقديم الطلب.
في لوحة "مستكشف واجهات برمجة التطبيقات"، انقر على رمز ملء الشاشة fullscreen لتوسيع نافذة "مستكشف واجهات برمجة التطبيقات".