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)

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

object (CustomLocalAqi)

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

integer

ไม่บังคับ จำนวนสูงสุดของบันทึกข้อมูลรายชั่วโมงที่จะแสดงผลต่อหน้า (ค่าเริ่มต้น = 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 สากลจะรวมอยู่ในช่อง "ดัชนี" ของคำตอบ (ค่าเริ่มต้น = จริง)
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)

รายการสารมลพิษที่ส่งผลต่อสถานที่ที่ระบุในคําขอ

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

object (HealthRecommendations)

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