Method: history.lookup

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

คำขอ HTTP

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

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

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

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

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

integer

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

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 ของสหรัฐอเมริกาสำหรับแคนาดาแทนที่จะใช้ดัชนีเริ่มต้นสำหรับแคนาดา
dateTime

string (Timestamp format)

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

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

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

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

integer

ตัวเลขตั้งแต่ 1 ถึง 720 ที่ระบุช่วงเวลาของคำขอ เช่น ค่า 48 จะให้ข้อมูลจาก 48 ชั่วโมงที่ผ่านมา
period

object (Interval)

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

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

boolean

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

string

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

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

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

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

object (HourInfo)

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

string

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

string

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

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

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

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

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

HourInfo

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

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

string (Timestamp format)

การประทับเวลาแบบปัดเศษลงจะระบุเวลาที่ข้อมูลอ้างถึงในรูปแบบ RFC3339 UTC "ซูลู" มีความละเอียดระดับนาโนวินาทีและตัวเลขเศษส่วนได้สูงสุด 9 หลัก เช่น "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)

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