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)
    }
  ],

  // Union field time_range can be only one of the following:
  "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 ของสหรัฐอเมริกาสำหรับแคนาดาแทนที่จะใช้ดัชนีเริ่มต้นสำหรับแคนาดา

ฟิลด์การรวม time_range ช่วงเวลาของข้อมูลคุณภาพอากาศที่ต้องการ หากไม่ระบุช่องที่เกี่ยวข้องกับช่วงเวลาจะทำให้เกิดข้อผิดพลาด INVALID_ARGUMENT เวลาสามารถเป็นได้อย่างใดอย่างหนึ่งต่อไปนี้ time_range ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
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"

hours

integer

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

period

object (Interval)

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

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

ช่วงเวลา

แสดงช่วงเวลา ซึ่งเข้ารหัสโดยการเริ่มใช้การประทับเวลา (รวม) และสิ้นสุดการประทับเวลา (ไม่รวม)

จุดเริ่มต้นต้องน้อยกว่าหรือเท่ากับจุดสิ้นสุด เมื่อจุดเริ่มต้นเท่ากับจุดสิ้นสุด ช่วงเวลาจะว่างเปล่า (ไม่จับคู่กับเวลา) เมื่อไม่ได้ระบุทั้งจุดเริ่มต้นและจุดสิ้นสุด ช่วงระยะเวลาจะจับคู่กันได้ทุกเมื่อ

การแสดง JSON
{
  "startTime": string,
  "endTime": string
}
ช่อง
startTime

string (Timestamp format)

ไม่บังคับ ช่วงเริ่มต้นแบบไม่รวม

หากระบุไว้ การประทับเวลาที่ตรงกับช่วงเวลานี้จะต้องเป็นรายการเดียวกันหรือหลังจากจุดเริ่มต้น

endTime

string (Timestamp format)

ไม่บังคับ เวลาสิ้นสุดของช่วงเวลาสุดพิเศษ

หากระบุไว้ การประทับเวลาที่ตรงกับช่วงเวลานี้จะต้องอยู่ก่อนวันที่สิ้นสุด

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)

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