Method: currentConditions.lookup

ปลายทางสภาพอากาศปัจจุบันให้ข้อมูลคุณภาพอากาศรายชั่วโมงในกว่า 100 ประเทศที่มีความละเอียดสูงสุด 500 x 500 เมตร มีดัชนีท้องถิ่น รวมถึงดัชนีและหมวดหมู่คุณภาพอากาศทั่วโลกกว่า 70 รายการ

คำขอ HTTP

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

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

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

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

การแสดง JSON 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "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 ของสหรัฐอเมริกาสำหรับแคนาดาแทนที่จะใช้ดัชนีเริ่มต้นสำหรับแคนาดา
universalAqi

boolean

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

string

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

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

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

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

string (Timestamp format)

การประทับเวลาที่ปัดเศษลงในรูปแบบ RFC3339 UTC "ซูลู" ที่มีความละเอียดระดับนาโนวินาทีและมีเศษส่วนได้สูงสุด 9 หลัก เช่น "2014-10-02T15:00:00Z"
regionCode

string

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

object (AirQualityIndex)

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

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

object (Pollutant)

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

object (HealthRecommendations)

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

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

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

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0