Method: forecast.lookup

แสดงการพยากรณ์คุณภาพอากาศสำหรับตำแหน่งที่เฉพาะเจาะจงในช่วงเวลาที่กำหนด

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "pageSize": integer,
  "pageToken": string,
  "dateTime": string,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
ช่อง
location

object (LatLng)

ต้องระบุ ละติจูดและลองจิจูดที่ API ค้นหาข้อมูลคุณภาพอากาศ
extraComputations[]

enum (ExtraComputation)

ไม่บังคับ ฟีเจอร์เพิ่มเติมที่เลือกเปิดใช้ได้ การระบุการคำนวณเพิ่มเติมจะส่งผลให้ระบบแสดงองค์ประกอบและช่องที่เกี่ยวข้องในคำตอบ
uaqiColorPalette

enum (ColorPalette)

ไม่บังคับ กำหนดชุดสีที่ใช้สำหรับข้อมูลที่ได้จาก "ดัชนีคุณภาพอากาศสากล" (UAQI) ชุดสีนี้เกี่ยวข้องกับ UAQI เท่านั้น ส่วน AQI อื่นๆ มีชุดสีที่กําหนดไว้ล่วงหน้าซึ่งควบคุมไม่ได้
customLocalAqis[]

object (CustomLocalAqi)

ไม่บังคับ แสดง "ประเทศ/ภูมิภาคต่อ AQI" ความสัมพันธ์ จับคู่ประเทศ/ภูมิภาคกับ AQI ที่ต้องการเพื่อให้ระบบแสดงข้อมูลคุณภาพอากาศที่จำเป็นสำหรับประเทศ/ภูมิภาคนั้นตาม AQI ที่เลือก พารามิเตอร์นี้ใช้เพื่อระบุ AQI ที่ไม่ใช่ค่าเริ่มต้นสำหรับประเทศหนึ่งๆ ได้ เช่น เพื่อรับดัชนี EPA สหรัฐอเมริกาสำหรับแคนาดาแทนดัชนีเริ่มต้นสำหรับแคนาดา
pageSize

integer

ไม่บังคับ จำนวนสูงสุดของบันทึกข้อมูลรายชั่วโมงที่จะแสดงต่อ 1 หน้า (ค่าเริ่มต้น = 24)
pageToken

string

ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการเรียกใช้การคาดการณ์ก่อนหน้านี้ ซึ่งใช้เพื่อเรียกดูหน้าถัดไป
dateTime

string (Timestamp format)

การประทับเวลาที่จะแสดงข้อมูลสำหรับช่วงเวลาที่เฉพาะเจาะจง การประทับเวลาจะปัดเศษเป็นชั่วโมงก่อนหน้า

การดำเนินการนี้จะแสดงผลข้อมูลรายชั่วโมงสำหรับการประทับเวลาที่ขอเท่านั้น (เช่น องค์ประกอบข้อมูลรายชั่วโมงเดี่ยว) ตัวอย่างเช่น คําขอที่ส่งโดยมีการตั้งค่าพารามิเตอร์ dateTime เป็น 2023-01-03T11:05:49Z จะปัดเศษลงเป็น 2023-01-03T11:00:00Z

หมายเหตุ: คุณใช้ทั้ง dateTime หรือ startTime และ endTime ในคำขอได้
period

object (Interval)

ระบุช่วงเวลาstartTimeและendTimeที่จะรับข้อมูลการคาดการณ์ endTime เป็นแบบครอบคลุม การประทับเวลาจะปัดเศษเป็นชั่วโมงก่อนหน้า

หมายเหตุ: คุณใช้ dateTime หรือ startTime และ endTime ในคำขอได้
universalAqi

boolean

ไม่บังคับ หากตั้งค่าเป็น "จริง" AQI สากลจะรวมอยู่ใน "ดัชนี" ของคำตอบ (ค่าเริ่มต้น = true)
languageCode

string

ไม่บังคับ อนุญาตให้ไคลเอ็นต์เลือกภาษาสำหรับคำตอบ หากไม่สามารถระบุข้อมูลสำหรับภาษานั้นได้ API จะใช้การจับคู่ที่ใกล้เคียงที่สุด ค่าที่อนุญาตต้องยึดตามมาตรฐาน IETF (ค่าเริ่มต้น = "en")

เนื้อหาการตอบกลับ

ออบเจ็กต์การตอบสนองของ API การคาดการณ์คุณภาพอากาศ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
ช่อง
hourlyForecasts[]

object (HourlyForecast)

ไม่บังคับ มีข้อมูลคุณภาพอากาศสำหรับแต่ละชั่วโมงในช่วงที่ขอ ตัวอย่างเช่น หากเป็นคำขอสำหรับการคาดการณ์ 48 ชั่วโมง จะมี 48 องค์ประกอบของการคาดการณ์รายชั่วโมง
regionCode

string

ไม่บังคับ รหัส ISO_3166-1 alpha-2 ของประเทศ/ภูมิภาคที่ตรงกับสถานที่ตั้งที่ระบุไว้ในคําขอ ช่องนี้อาจไม่แสดงในคำตอบหากตำแหน่งที่ระบุไว้ในคำขออยู่ในเขตแดนที่มีการโต้แย้ง
nextPageToken

string

ไม่บังคับ โทเค็นสำหรับเรียกข้อมูลหน้าถัดไป

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0

HourlyForecast

มีข้อมูลคุณภาพอากาศสำหรับแต่ละชั่วโมงในช่วงที่ขอ ตัวอย่างเช่น หากเป็นคำขอสำหรับการคาดการณ์ 48 ชั่วโมง จะมี 48 องค์ประกอบของการคาดการณ์รายชั่วโมง

การแสดง JSON 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
ช่อง
dateTime

string (Timestamp format)

การประทับเวลาที่ปัดเศษลงซึ่งระบุเวลา (ชั่วโมง) ที่ข้อมูลอ้างถึงใน "ซูลู" RFC3339 UTC เช่น "2014-10-02T15:00:00Z"
indexes[]

object (AirQualityIndex)

รายการนี้ประกอบด้วยดัชนีคุณภาพอากาศ (สูงสุด) 2 รายการตามพารามิเตอร์คำขอ ได้แก่

  • AQI ระดับสากล ระบบจะแสดงผลหากตั้งค่าบูลีน universalAqi เป็น "จริง"
  • AQI ระดับท้องถิ่น จะส่งคืนหากมีการระบุการคำนวณเพิ่มเติม LOCAL_AQI
pollutants[]

object (Pollutant)

รายการสารมลพิษที่ส่งผลต่อตำแหน่งที่ระบุไว้ในคำขอ

หมายเหตุ: ฟิลด์นี้จะส่งคืนเฉพาะคำขอที่ระบุการคำนวณเพิ่มเติมต่อไปนี้: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION
healthRecommendations

object (HealthRecommendations)

คำแนะนำด้านสุขภาพและการดำเนินการที่แนะนำที่เกี่ยวข้องกับสภาวะคุณภาพอากาศที่รายงาน คำแนะนำได้รับการปรับให้เหมาะกับประชากรที่มีความเสี่ยง กลุ่มที่มีความไวต่อสารมลพิษมากกว่า และกลุ่มประชากรทั่วไป