แสดงการพยากรณ์คุณภาพอากาศสำหรับตำแหน่งที่เฉพาะเจาะจงในช่วงเวลาที่กำหนด
คำขอ HTTP
POST https://airquality.googleapis.com/v1/forecast:lookup
URL ใช้ไวยากรณ์การแปลง gRPC
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "location": { object ( |
ช่อง | |
---|---|
location |
ต้องระบุ ละติจูดและลองจิจูดที่ API ค้นหาข้อมูลคุณภาพอากาศ |
extraComputations[] |
ไม่บังคับ ฟีเจอร์เพิ่มเติมที่เลือกเปิดใช้ได้ การระบุการคำนวณเพิ่มเติมจะส่งผลให้ระบบแสดงองค์ประกอบและช่องที่เกี่ยวข้องในคำตอบ |
uaqiColorPalette |
ไม่บังคับ กำหนดชุดสีที่ใช้สำหรับข้อมูลที่ได้จาก "ดัชนีคุณภาพอากาศสากล" (UAQI) ชุดสีนี้เกี่ยวข้องกับ UAQI เท่านั้น ส่วน AQI อื่นๆ มีชุดสีที่กําหนดไว้ล่วงหน้าซึ่งควบคุมไม่ได้ |
customLocalAqis[] |
ไม่บังคับ แสดง "ประเทศ/ภูมิภาคต่อ AQI" ความสัมพันธ์ จับคู่ประเทศ/ภูมิภาคกับ AQI ที่ต้องการเพื่อให้ระบบแสดงข้อมูลคุณภาพอากาศที่จำเป็นสำหรับประเทศ/ภูมิภาคนั้นตาม AQI ที่เลือก พารามิเตอร์นี้ใช้เพื่อระบุ AQI ที่ไม่ใช่ค่าเริ่มต้นสำหรับประเทศหนึ่งๆ ได้ เช่น เพื่อรับดัชนี EPA สหรัฐอเมริกาสำหรับแคนาดาแทนดัชนีเริ่มต้นสำหรับแคนาดา |
pageSize |
ไม่บังคับ จำนวนสูงสุดของบันทึกข้อมูลรายชั่วโมงที่จะแสดงต่อ 1 หน้า (ค่าเริ่มต้น = 24) |
pageToken |
ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการเรียกใช้การคาดการณ์ก่อนหน้านี้ ซึ่งใช้เพื่อเรียกดูหน้าถัดไป |
dateTime |
การประทับเวลาที่จะแสดงข้อมูลสำหรับช่วงเวลาที่เฉพาะเจาะจง การประทับเวลาจะปัดเศษเป็นชั่วโมงก่อนหน้า การดำเนินการนี้จะแสดงผลข้อมูลรายชั่วโมงสำหรับการประทับเวลาที่ขอเท่านั้น (เช่น องค์ประกอบข้อมูลรายชั่วโมงเดี่ยว) ตัวอย่างเช่น คําขอที่ส่งโดยมีการตั้งค่าพารามิเตอร์ dateTime เป็น 2023-01-03T11:05:49Z จะปัดเศษลงเป็น 2023-01-03T11:00:00Z หมายเหตุ: คุณใช้ทั้ง |
period |
ระบุช่วงเวลา หมายเหตุ: คุณใช้ |
universalAqi |
ไม่บังคับ หากตั้งค่าเป็น "จริง" AQI สากลจะรวมอยู่ใน "ดัชนี" ของคำตอบ (ค่าเริ่มต้น = true) |
languageCode |
ไม่บังคับ อนุญาตให้ไคลเอ็นต์เลือกภาษาสำหรับคำตอบ หากไม่สามารถระบุข้อมูลสำหรับภาษานั้นได้ API จะใช้การจับคู่ที่ใกล้เคียงที่สุด ค่าที่อนุญาตต้องยึดตามมาตรฐาน IETF (ค่าเริ่มต้น = "en") |
เนื้อหาการตอบกลับ
ออบเจ็กต์การตอบสนองของ API การคาดการณ์คุณภาพอากาศ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"hourlyForecasts": [
{
object ( |
ช่อง | |
---|---|
hourlyForecasts[] |
ไม่บังคับ มีข้อมูลคุณภาพอากาศสำหรับแต่ละชั่วโมงในช่วงที่ขอ ตัวอย่างเช่น หากเป็นคำขอสำหรับการคาดการณ์ 48 ชั่วโมง จะมี 48 องค์ประกอบของการคาดการณ์รายชั่วโมง |
regionCode |
ไม่บังคับ รหัส ISO_3166-1 alpha-2 ของประเทศ/ภูมิภาคที่ตรงกับสถานที่ตั้งที่ระบุไว้ในคําขอ ช่องนี้อาจไม่แสดงในคำตอบหากตำแหน่งที่ระบุไว้ในคำขออยู่ในเขตแดนที่มีการโต้แย้ง |
nextPageToken |
ไม่บังคับ โทเค็นสำหรับเรียกข้อมูลหน้าถัดไป |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/cloud-platform
สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0
HourlyForecast
มีข้อมูลคุณภาพอากาศสำหรับแต่ละชั่วโมงในช่วงที่ขอ ตัวอย่างเช่น หากเป็นคำขอสำหรับการคาดการณ์ 48 ชั่วโมง จะมี 48 องค์ประกอบของการคาดการณ์รายชั่วโมง
การแสดง JSON |
---|
{ "dateTime": string, "indexes": [ { object ( |
ช่อง | |
---|---|
dateTime |
การประทับเวลาที่ปัดเศษลงซึ่งระบุเวลา (ชั่วโมง) ที่ข้อมูลอ้างถึงใน "ซูลู" RFC3339 UTC เช่น "2014-10-02T15:00:00Z" |
indexes[] |
รายการนี้ประกอบด้วยดัชนีคุณภาพอากาศ (สูงสุด) 2 รายการตามพารามิเตอร์คำขอ ได้แก่
|
pollutants[] |
รายการสารมลพิษที่ส่งผลต่อตำแหน่งที่ระบุไว้ในคำขอ หมายเหตุ: ฟิลด์นี้จะส่งคืนเฉพาะคำขอที่ระบุการคำนวณเพิ่มเติมต่อไปนี้: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION |
healthRecommendations |
คำแนะนำด้านสุขภาพและการดำเนินการที่แนะนำที่เกี่ยวข้องกับสภาวะคุณภาพอากาศที่รายงาน คำแนะนำได้รับการปรับให้เหมาะกับประชากรที่มีความเสี่ยง กลุ่มที่มีความไวต่อสารมลพิษมากกว่า และกลุ่มประชากรทั่วไป |