Package google.maps.airquality.v1

ดัชนี

AirQuality

บริการคุณภาพอากาศ

LookupCurrentConditions

rpc LookupCurrentConditions(LookupCurrentConditionsRequest) returns (LookupCurrentConditionsResponse)

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

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

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

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

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

rpc LookupForecast(LookupForecastRequest) returns (LookupForecastResponse)

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

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

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

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

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

rpc LookupHeatmapTile(LookupHeatmapTileRequest) returns (HttpBody)

แสดงผลอาร์เรย์ไบต์ที่มีข้อมูลของรูปภาพ PNG ของไทล์

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

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

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

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

rpc LookupHistory(LookupHistoryRequest) returns (LookupHistoryResponse)

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

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

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

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

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

AirQualityIndex

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

ช่อง
code

string

โค้ดของดัชนี ช่องนี้แสดงดัชนีสำหรับวัตถุประสงค์ในการเขียนโปรแกรมโดยใช้ Snake Case แทนการเว้นวรรค เช่น "uaqi", "fra_atmo"
display_name

string

ชื่อดัชนีที่มนุษย์อ่านได้ ตัวอย่างเช่น "AQI (สหรัฐอเมริกา)"
aqi_display

string

ข้อความนำเสนอคะแนนตัวเลขดัชนี ซึ่งอาจมีสัญลักษณ์นำหน้าหรือต่อท้าย ซึ่งมักแสดงคะแนนดัชนีที่แย่ที่สุด ตัวอย่างเช่น >100 หรือ 10+

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

Color

สีที่ใช้แสดงคะแนนตัวเลข AQI
category

string

การจัดประเภทแบบข้อความของการตีความตัวเลขคะแนนดัชนี เช่น "คุณภาพอากาศดีมาก"
dominant_pollutant

string

สัญลักษณ์ทางเคมีของสารมลพิษจำเพาะ เช่น "CO"
aqi

int32

คะแนนตัวเลขของดัชนี เช่น 10, 100

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

หมายเหตุ: ฟิลด์นี้ควรใช้ในการคำนวณ แสดงกราฟ ฯลฯ และควรใช้ฟิลด์การแสดงผล AQI เพื่อแสดงคะแนนดัชนี

ColorPalette

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

Enum
COLOR_PALETTE_UNSPECIFIED ค่าเริ่มต้น ละเว้นหากส่งผ่านในรูปแบบพารามิเตอร์
RED_GREEN กำหนดว่าจะใช้ชุดสีแดง/เขียวหรือไม่
INDIGO_PERSIAN_DARK กำหนดว่าจะใช้ชุดสีคราม/เปอร์เซีย (ธีมมืด) หรือไม่
INDIGO_PERSIAN_LIGHT กำหนดว่าจะใช้ชุดสีคราม/เปอร์เซีย (ธีมสว่าง) หรือไม่

CustomLocalAqi

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

ช่อง
region_code

string

ประเทศ/ภูมิภาคที่ต้องใช้ AQI ที่กำหนดเอง คุณควรระบุค่าโดยใช้รหัส ISO 3166-1 alpha-2
aqi

string

AQI ที่จะเชื่อมโยงกับประเทศ/ภูมิภาค ค่าควรเป็นโค้ดดัชนีที่ถูกต้อง

ExtraComputation

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

Enum
EXTRA_COMPUTATION_UNSPECIFIED ค่าเริ่มต้น เซิร์ฟเวอร์จะไม่สนใจพารามิเตอร์นี้หากส่งผ่านในรูปแบบพารามิเตอร์
LOCAL_AQI

กำหนดว่าจะรวม AQI ระดับท้องถิ่น (ระดับประเทศ) ของตำแหน่ง (ประเทศ) ที่ขอไว้ในคำตอบหรือไม่

หากระบุไว้ คำตอบจะมีโครงสร้างข้อมูล "air_quality_index" พร้อมข้อมูลที่เกี่ยวข้องทั้งหมดเกี่ยวกับ AQI ในท้องถิ่นของตำแหน่งนั้น
HEALTH_RECOMMENDATIONS

กำหนดว่าการตอบสนองจะรวมคำแนะนำด้านสุขภาพและการดำเนินการที่แนะนำสำหรับสภาพ AQI ปัจจุบันหรือไม่

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

หากระบุ ระบบจะเติมข้อมูลในช่อง health_recommendations ในคำตอบเมื่อมีข้อมูลที่เกี่ยวข้อง
POLLUTANT_ADDITIONAL_INFO

กำหนดว่าจะรวมข้อมูลเพิ่มเติมของสารมลพิษแต่ละอย่างไว้ในการตอบสนองหรือไม่

หากระบุไว้ ออบเจ็กต์ดัชนีคุณภาพอากาศแต่ละรายการที่อยู่ในการตอบสนองของช่อง "ดัชนี" จะรวมช่อง additional_info เมื่อมีข้อมูล
DOMINANT_POLLUTANT_CONCENTRATION

พิจารณาว่าการตอบสนองจะรวมความเข้มข้นของสารมลพิษที่โดดเด่นที่วัดตามดัชนีทั่วโลกและ/หรือในพื้นที่หรือไม่

หากคำขอระบุทั้ง AQI ทั่วโลกและ AQI ระดับท้องถิ่น อาจมีการส่งคืนรหัสสารมลพิษสูงสุด 2 รายการ

หากระบุไว้ วัตถุมลพิษที่โดดเด่นอยู่ในรายการ "มลพิษ" จะรวมช่อง concentration เมื่อมีข้อมูล
POLLUTANT_CONCENTRATION

พิจารณาว่าการตอบสนองจะรวมความเข้มข้นของสารมลพิษทั้งหมดซึ่งมีค่าที่วัดได้ตามดัชนีทั่วโลกและ/หรือท้องถิ่นหรือไม่

หากระบุไว้ วัตถุมลพิษแต่ละรายการที่อยู่ในช่อง "มลพิษ" ในการตอบสนองจะรวมช่อง concentration เมื่อมีข้อมูล

HealthRecommendations

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

ช่อง
general_population

string

ไม่มีความละเอียดอ่อนที่เฉพาะเจาะจง
elderly

string

ผู้เกษียณอายุและผู้ที่มีอายุมากกว่าประชากรทั่วไป
lung_disease_population

string

ทุกข์ทรมานเกี่ยวกับระบบทางเดินหายใจและโรคหอบหืด
heart_disease_population

string

โรคเกี่ยวกับหัวใจและระบบไหลเวียนโลหิต
athletes

string

กีฬาและกิจกรรมกลางแจ้งที่ต้องใช้กําลังมาก
pregnant_women

string

ผู้หญิงในทุกระยะของการตั้งครรภ์
children

string

ประชากรที่อายุน้อย ซึ่งรวมถึงเด็ก เด็กเล็ก และทารก

LookupCurrentConditionsRequest

คำจำกัดความคำขอเกี่ยวกับสภาวะปัจจุบันของคุณภาพอากาศ

ช่อง
location

LatLng

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

ExtraComputation

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

ColorPalette

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

CustomLocalAqi

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

bool

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

string

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

LookupCurrentConditionsResponse

ช่อง
date_time

Timestamp

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

string

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

AirQualityIndex

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

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

Pollutant

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

HealthRecommendations

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

LookupForecastRequest

ออบเจ็กต์คำขอของ API การคาดการณ์คุณภาพอากาศ

ช่อง
location

LatLng

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

ExtraComputation

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

ColorPalette

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

CustomLocalAqi

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

int32

ไม่บังคับ จำนวนสูงสุดของบันทึกข้อมูลรายชั่วโมงที่จะแสดงผลต่อหน้า (ค่าเริ่มต้น = 24)
page_token

string

ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการเรียกใช้การคาดการณ์ครั้งก่อน ซึ่งจะใช้เพื่อเรียกข้อมูลหน้าต่อๆ ไป
ฟิลด์สหภาพ time_range ช่วงเวลาของข้อมูลการคาดการณ์คุณภาพอากาศที่จำเป็น ช่วงจะต้องไม่ต่ำกว่า 1 ชั่วโมงโดยปัดเศษนับจากนี้ การไม่ระบุฟิลด์นี้จะทำให้เกิดข้อผิดพลาด INVALID_ARGUMENT time_range ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
date_time

Timestamp

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

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

Interval

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

bool

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

string

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

LookupForecastResponse

ออบเจ็กต์การตอบสนองของ API การคาดการณ์คุณภาพอากาศ

ช่อง
hourly_forecasts[]

HourlyForecast

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

string

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

string

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

HourlyForecast

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

ช่อง
date_time

Timestamp

การประทับเวลาแบบปัดเศษลงจะแสดงเวลา (ชั่วโมง) ที่ข้อมูลอ้างถึงในรูปแบบ RFC3339 UTC "ซูลู" เช่น "2014-10-02T15:00:00Z"
indexes[]

AirQualityIndex

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

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

Pollutant

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

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

HealthRecommendations

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

LookupHeatmapTileRequest

คำขอการ์ดแผนที่ความหนาแน่น

โครงสร้างเป็นไปตามการเรียกใช้ GET ที่เซิร์ฟเวอร์การ์ดมาตรฐาน เช่น https://airquality.googleapis.com/v1/mapTypes/{map_type}/heatmapTiles/{zoom}/{x}/{y}

ตัวอย่างเช่น https://airquality.googleapis.com/v1/mapTypes/BAQI_INDIGO_PERSIAN/heatmapTiles/1/1/1

ช่อง
map_type

MapType

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

Allowed values:
- UAQI_RED_GREEN (UAQI, red-green palette)
- UAQI_INDIGO_PERSIAN (UAQI, indigo-persian palette)
- PM25_INDIGO_PERSIAN
- GBR_DEFRA
- DEU_UBA
- CAN_EC
- FRA_ATMO
- US_AQI
zoom

int32

ต้องระบุ ระดับการซูมของแผนที่ กำหนดว่าเนื้อหาของแผนที่ขนาดใหญ่หรือเล็กจะปรากฏในมุมมองแผนที่มากน้อยเพียงใด

ระดับการซูม 0 คือโลกทั้งใบในไทล์เดียว ระดับการซูม 1 คือโลกทั้งใบใน 4 ชิ้นส่วน ระดับการซูม 2 คือโลกทั้งใบใน 16 ไทล์ ระดับการซูม 16 คือโลกทั้งใบในไทล์ 65,536 ชิ้น

ค่าที่อนุญาต: 0-16
x

int32

ต้องระบุ กำหนดจุดตะวันออก-ตะวันตกในไทล์ที่ขอ
y

int32

ต้องระบุ กำหนดจุดเหนือ-ใต้ในไทล์ที่ขอ

LookupHistoryRequest

ออบเจ็กต์คำขอของ API ประวัติคุณภาพอากาศ

ช่อง
page_size

int32

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

string

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

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

LatLng

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

ExtraComputation

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

ColorPalette

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

CustomLocalAqi

ไม่บังคับ แสดงความสัมพันธ์ "ประเทศ/ภูมิภาคเป็น AQI" จับคู่ประเทศ/ภูมิภาคกับ AQI ที่ต้องการเพื่อให้ข้อมูลคุณภาพอากาศที่จำเป็นสำหรับประเทศ/ภูมิภาคนั้นแสดงตาม AQI ที่เลือก พารามิเตอร์นี้ใช้เพื่อระบุ AQI ที่ไม่ใช่ค่าเริ่มต้นสำหรับประเทศที่ระบุได้ เช่น เพื่อให้ได้ดัชนี EPA ของสหรัฐอเมริกาสำหรับแคนาดาแทนที่จะใช้ดัชนีเริ่มต้นสำหรับแคนาดา
ฟิลด์สหภาพ time_range ช่วงเวลาของข้อมูลคุณภาพอากาศที่ต้องการ การไม่ระบุช่องที่เกี่ยวข้องกับช่วงเวลาใดๆ จะส่งผลให้เกิดข้อผิดพลาด <b>ไม่ถูกต้อง</b> โดย time_range สามารถเป็นได้ดังต่อไปนี้เท่านั้น: time_range สามารถเป็นได้ดังต่อไปนี้เท่านั้น:
date_time

Timestamp

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

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

int32

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

Interval

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

bool

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

string

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

LookupHistoryResponse

ช่อง
hours_info[]

HourInfo

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

string

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

string

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

HourInfo

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

ช่อง
date_time

Timestamp

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

AirQualityIndex

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

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

Pollutant

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

HealthRecommendations

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

MapType

ประเภทแผนที่ความหนาแน่นเกี่ยวกับคุณภาพอากาศ ระบุสารมลพิษที่แผนที่จะแสดงในรูปแบบกราฟิก

Enum
MAP_TYPE_UNSPECIFIED ค่าเริ่มต้น เซิร์ฟเวอร์จะไม่สนใจพารามิเตอร์นี้หากส่งผ่านในรูปแบบพารามิเตอร์
UAQI_RED_GREEN ชุดดัชนีคุณภาพอากาศสากล (Universal Air Quality Index) สีแดง-เขียว
UAQI_INDIGO_PERSIAN ชุดสีครามเปอร์เซียของดัชนีคุณภาพอากาศสากล
PM25_INDIGO_PERSIAN ชุดจานสีอินดิโก-เปอร์เซีย ดัชนี PM2.5
GBR_DEFRA ชุดสีของดัชนีคุณภาพอากาศรายวัน (สหราชอาณาจักร)
DEU_UBA ชุดสีของดัชนีคุณภาพอากาศท้องถิ่นของเยอรมนี
CAN_EC ชุดสีของดัชนีสุขภาพคุณภาพอากาศของแคนาดา
FRA_ATMO ชุดสีของดัชนีคุณภาพอากาศฝรั่งเศส
US_AQI ชุดสีของดัชนีคุณภาพอากาศในสหรัฐอเมริกา

สารมลพิษ

ข้อมูลเกี่ยวกับสารมลพิษคุณภาพอากาศ

ช่อง
code

string

ชื่อรหัสของสารมลพิษ เช่น "so2" ดูรายการรหัสที่ใช้ได้ทั้งหมดที่นี่
display_name

string

ชื่อที่แสดงของสารมลพิษ เช่น "NOx"
full_name

string

ชื่อเต็มของสารมลพิษ สำหรับสารประกอบเคมี นี่คือชื่อ IUPAC ตัวอย่าง: "ซัลเฟอร์ไดออกไซด์"

ดูข้อมูลเพิ่มเติมเกี่ยวกับตารางชื่อ IUPAC ได้ที่ https://iupac.org/what-we-do/periodic-table-of-elements/
concentration

Concentration

ระดับความเข้มข้นของสารมลพิษที่วัดจากหน่วยวัดมลพิษทางอากาศมาตรฐานหน่วยใดหน่วยหนึ่ง
additional_info

AdditionalInfo

ข้อมูลเพิ่มเติมเกี่ยวกับสารมลพิษ

AdditionalInfo

แหล่งปล่อยก๊าซและผลกระทบต่อสุขภาพจากสารมลพิษที่ระบุ

ช่อง
sources

string

ข้อความแสดงแหล่งมลพิษหลักของสารมลพิษ
effects

string

ข้อความที่แสดงถึงผลกระทบหลักของสารมลพิษต่อสุขภาพ

ความเข้มข้น

ความเข้มข้นของสารมลพิษในอากาศ

ช่อง
units

Unit

หน่วยวัดความเข้มข้นของสารมลพิษนี้
value

float

ค่าความเข้มข้นของสารมลพิษ

หน่วย

ระบุหน่วยที่ใช้วัดความเข้มข้นของสารมลพิษ

Enum
UNIT_UNSPECIFIED หน่วยความเข้มข้นที่ไม่ระบุ
PARTS_PER_BILLION หน่วยความเข้มข้นของ ppb (ส่วนต่อพันล้าน)
MICROGRAMS_PER_CUBIC_METER หน่วยความเข้มข้น "μg/m^3" (ไมโครกรัมต่อลูกบาศก์เมตร)