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

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

string

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

โปรดทราบว่าเมื่อระบุค่าสำหรับพารามิเตอร์นี้ พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุต้องตรงกับการเรียกใช้ที่ระบุโทเค็นของหน้าเว็บ (การเรียกก่อนหน้า)
location

object (LatLng)

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

enum (ExtraComputation)

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

enum (ColorPalette)

ไม่บังคับ กำหนดชุดสีที่ใช้สำหรับข้อมูลที่ได้จาก "ดัชนีคุณภาพอากาศสากล" (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)

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

object (HealthRecommendations)

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