Indeks
AirQuality
(antarmuka)AirQualityIndex
(pesan)ColorPalette
(enum)CustomLocalAqi
(pesan)ExtraComputation
(enum)HealthRecommendations
(pesan)LookupCurrentConditionsRequest
(pesan)LookupCurrentConditionsResponse
(pesan)LookupForecastRequest
(pesan)LookupForecastResponse
(pesan)LookupForecastResponse.HourlyForecast
(pesan)LookupHeatmapTileRequest
(pesan)LookupHistoryRequest
(pesan)LookupHistoryResponse
(pesan)LookupHistoryResponse.HourInfo
(pesan)MapType
(enum)Pollutant
(pesan)Pollutant.AdditionalInfo
(pesan)Pollutant.Concentration
(pesan)Pollutant.Concentration.Unit
(enum)
AirQuality
Layanan kualitas udara.
LookupCurrentConditions |
---|
Endpoint Kondisi Saat Ini memberikan informasi kualitas udara per jam di lebih dari 100 negara, hingga resolusi 500 x 500 meter. Mencakup lebih dari 70 indeks lokal serta kategori dan indeks kualitas udara global.
|
LookupForecast |
---|
Menampilkan perkiraan kualitas udara untuk lokasi tertentu selama rentang waktu tertentu.
|
LookupHeatmapTile |
---|
Menampilkan array byte yang berisi data gambar PNG ubin.
|
LookupHistory |
---|
Menampilkan histori kualitas udara untuk lokasi tertentu selama rentang waktu tertentu.
|
AirQualityIndex
Objek dasar untuk merepresentasikan berbagai metrik kualitas udara. Jika digabungkan, metrik ini memberikan ringkasan tentang kondisi kualitas udara saat ini. Ada beberapa indeks di dunia yang memiliki tujuan dan grup yang berbeda-beda yang tertarik untuk mengukur berbagai aspek kualitas udara.
Kolom | |
---|---|
code |
Kode indeks. Kolom ini mewakili indeks untuk tujuan pemrograman dengan menggunakan snake case, bukan spasi. Contoh: "uaqi", "fra_atmo". |
display_name |
Representasi nama indeks yang dapat dibaca manusia. Contoh: "AQI (US)" |
aqi_display |
Representasi tekstual skor numerik indeks, yang dapat mencakup simbol awalan atau akhiran, yang biasanya mewakili skor indeks terburuk. Contoh: >100 atau 10+. Catatan: Kolom ini harus digunakan jika Anda ingin menampilkan skor indeks. Untuk indeks non-numerik, kolom ini kosong. |
color |
Warna yang digunakan untuk mewakili skor numerik AQI. |
category |
Klasifikasi tekstual interpretasi skor numerik indeks. Misalnya: "Kualitas udara sangat baik". |
dominant_pollutant |
Simbol kimia polutan dominan. Misalnya: "CO". |
aqi |
Skor numerik indeks. Contoh: 10, 100. Nilai ini tidak dinormalisasi dan hanya boleh ditafsirkan dalam konteks indeks kualitas udara terkait. Untuk indeks non-numerik, kolom ini tidak akan ditampilkan. Catatan: Kolom ini harus digunakan untuk penghitungan, tampilan grafik, dll. Untuk menampilkan skor indeks, Anda harus menggunakan kolom tampilan AQI. |
ColorPalette
Menentukan palet warna yang digunakan untuk data yang disediakan oleh "Universal Air Quality Index" (UAQI). Palet warna ini hanya relevan untuk UAQI, AQI lainnya memiliki palet warna yang telah ditentukan sebelumnya dan tidak dapat dikontrol.
Enum | |
---|---|
COLOR_PALETTE_UNSPECIFIED |
Nilai default. Diabaikan jika diteruskan sebagai parameter. |
RED_GREEN |
Menentukan apakah akan menggunakan palet merah/hijau. |
INDIGO_PERSIAN_DARK |
Menentukan apakah akan menggunakan palet indigo/persia (tema gelap). |
INDIGO_PERSIAN_LIGHT |
Menentukan apakah akan menggunakan palet indigo/persia (tema terang). |
CustomLocalAqi
Mengekspresikan hubungan 'negara/wilayah ke AQI'. Menyambungkan negara/wilayah dengan AQI yang diinginkan sehingga data kualitas udara yang diperlukan untuk negara/wilayah tersebut akan ditampilkan sesuai dengan AQI yang dipilih.
Kolom | |
---|---|
region_code |
Negara/wilayah yang mewajibkan AQI kustom. Nilai harus diberikan menggunakan kode ISO 3166-1 alpha-2. |
aqi |
AQI yang akan dikaitkan dengan negara/wilayah. Nilai harus berupa kode indeks yang valid. |
ExtraComputation
Fitur tambahan yang dapat diaktifkan secara opsional. Menentukan komputasi tambahan akan menyebabkan elemen dan kolom yang relevan ditampilkan dalam respons.
Enum | |
---|---|
EXTRA_COMPUTATION_UNSPECIFIED |
Nilai default. Server akan mengabaikannya jika diteruskan sebagai parameter. |
LOCAL_AQI |
Menentukan apakah akan menyertakan AQI lokal (nasional) dari lokasi (negara) yang diminta dalam respons. Jika ditentukan, respons akan berisi struktur data 'air_quality_index' dengan semua data yang relevan tentang AQI lokal lokasi. |
HEALTH_RECOMMENDATIONS |
Menentukan apakah respons akan menyertakan saran kesehatan dan tindakan yang direkomendasikan untuk kondisi AQI saat ini. Rekomendasi ini disesuaikan untuk populasi umum dan enam kelompok populasi berisiko yang memiliki sensitivitas yang lebih besar terhadap polutan dibandingkan populasi umum. Jika ditentukan, kolom |
POLLUTANT_ADDITIONAL_INFO |
Menentukan apakah akan menyertakan informasi tambahan tentang setiap polutan dalam respons. Jika ditentukan, setiap objek indeks kualitas udara yang terdapat dalam respons kolom 'indexes' akan menyertakan kolom |
DOMINANT_POLLUTANT_CONCENTRATION |
Menentukan apakah respons akan menyertakan konsentrasi polutan dominan yang diukur menurut indeks global dan/atau lokal. Jika permintaan menentukan AQI global dan AQI lokal, mungkin ada hingga dua kode polutan yang ditampilkan. Jika ditentukan, objek polutan dominan yang terdapat dalam daftar 'polutan' akan menyertakan kolom |
POLLUTANT_CONCENTRATION |
Menentukan apakah respons akan menyertakan konsentrasi semua polutan dengan pengukuran yang tersedia sesuai dengan indeks global dan/atau lokal. Jika ditentukan, setiap objek polutan yang terdapat di kolom 'pollutants' dalam respons akan menyertakan kolom |
HealthRecommendations
Rekomendasi kesehatan untuk berbagai kelompok populasi dalam format teks bebas. Rekomendasi ini berasal dari kondisi kualitas udara terkait.
Kolom | |
---|---|
general_population |
Tidak ada sensitivitas khusus. |
elderly |
Pensiunan dan orang yang lebih tua dari populasi umum. |
lung_disease_population |
Masalah terkait pernapasan dan penderita asma. |
heart_disease_population |
Penyakit jantung dan sistem sirkulasi. |
athletes |
Olahraga dan aktivitas outdoor berat lainnya. |
pregnant_women |
Wanita di semua tahap kehamilan. |
children |
Populasi yang lebih muda, termasuk anak-anak, balita, dan bayi. |
LookupCurrentConditionsRequest
Definisi permintaan kondisi kualitas udara saat ini.
Kolom | |
---|---|
location |
Wajib. Bujur dan lintang tempat API mencari data kondisi kualitas udara saat ini. |
extra_computations[] |
Opsional. Fitur tambahan yang dapat diaktifkan secara opsional. Menentukan komputasi tambahan akan menyebabkan elemen dan kolom yang relevan ditampilkan dalam respons. |
uaqi_color_palette |
Opsional. Menentukan palet warna yang digunakan untuk data yang disediakan oleh 'Universal Air Quality Index' (UAQI). Palet warna ini hanya relevan untuk UAQI, AQI lainnya memiliki palet warna yang telah ditentukan sebelumnya dan tidak dapat dikontrol. |
custom_local_aqis[] |
Opsional. Mengekspresikan hubungan 'negara/wilayah ke AQI'. Menyambungkan negara/wilayah dengan AQI yang diinginkan sehingga data kualitas udara yang diperlukan untuk negara/wilayah tersebut akan ditampilkan sesuai dengan AQI yang dipilih. Parameter ini dapat digunakan untuk menentukan AQI non-default untuk negara tertentu, misalnya, untuk mendapatkan indeks EPA Amerika Serikat untuk Kanada, bukan indeks default untuk Kanada. |
universal_aqi |
Opsional. Jika disetel ke true, AQI Universal akan disertakan dalam kolom 'indexes' respons. Nilai default adalah true. |
language_code |
Opsional. Memungkinkan klien memilih bahasa untuk respons. Jika data tidak dapat diberikan untuk bahasa tersebut, API akan menggunakan kecocokan terdekat. Nilai yang diizinkan bergantung pada standar IETF. Nilai defaultnya adalah en. |
LookupCurrentConditionsResponse
Kolom | |
---|---|
date_time |
Stempel waktu yang dibulatkan ke bawah dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Misalnya: "2014-10-02T15:00:00Z". |
region_code |
Kode ISO_3166-1 alpha-2 negara/wilayah yang sesuai dengan lokasi yang diberikan dalam permintaan. Kolom ini mungkin dihilangkan dari respons jika lokasi yang diberikan dalam permintaan berada di wilayah yang disengketakan. |
indexes[] |
Berdasarkan parameter permintaan, daftar ini akan menyertakan (maksimal) dua indeks kualitas udara:
|
pollutants[] |
Daftar polutan yang memengaruhi lokasi yang ditentukan dalam permintaan. Catatan: Kolom ini hanya akan ditampilkan untuk permintaan yang menentukan satu atau beberapa komputasi tambahan berikut: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION. |
health_recommendations |
Saran kesehatan dan tindakan yang direkomendasikan terkait kondisi kualitas udara yang dilaporkan. Rekomendasi disesuaikan secara berbeda untuk populasi berisiko, kelompok dengan sensitivitas yang lebih besar terhadap polutan, dan populasi umum. |
LookupForecastRequest
Objek permintaan API perkiraan kualitas udara.
Kolom | |
---|---|
location |
Wajib. Lintang dan bujur yang digunakan API untuk mencari data kualitas udara. |
extra_computations[] |
Opsional. Fitur tambahan yang dapat diaktifkan secara opsional. Menentukan komputasi tambahan akan menyebabkan elemen dan kolom yang relevan ditampilkan dalam respons. |
uaqi_color_palette |
Opsional. Menentukan palet warna yang digunakan untuk data yang disediakan oleh 'Universal Air Quality Index' (UAQI). Palet warna ini hanya relevan untuk UAQI, AQI lainnya memiliki palet warna yang telah ditentukan sebelumnya dan tidak dapat dikontrol. |
custom_local_aqis[] |
Opsional. Mengekspresikan hubungan 'negara/wilayah ke AQI'. Menyambungkan negara/wilayah dengan AQI yang diinginkan sehingga data kualitas udara yang diperlukan untuk negara/wilayah tersebut akan ditampilkan sesuai dengan AQI yang dipilih. Parameter ini dapat digunakan untuk menentukan AQI non-default untuk negara tertentu, misalnya, untuk mendapatkan indeks EPA Amerika Serikat untuk Kanada, bukan indeks default untuk Kanada. |
page_size |
Opsional. Jumlah maksimum data info per jam yang akan ditampilkan per halaman (default = 24). |
page_token |
Opsional. Token halaman yang diterima dari panggilan perkiraan sebelumnya. Ini digunakan untuk mengambil halaman berikutnya. |
Kolom union time_range . Rentang waktu data prakiraan kualitas udara yang diperlukan. Rentang harus setidaknya satu jam yang dibulatkan ke depan. Kegagalan untuk menentukan kolom ini akan mengakibatkan error INVALID_ARGUMENT. time_range hanya dapat berupa salah satu dari berikut: |
|
date_time |
Stempel waktu untuk menampilkan data pada titik waktu tertentu. Stempel waktu dibulatkan ke jam persis sebelumnya. Catatan: tindakan ini hanya akan menampilkan data per jam untuk stempel waktu yang diminta (yaitu satu elemen info per jam). Misalnya, permintaan yang dikirim dengan parameter date_time ditetapkan ke 2023-01-03T11:05:49Z akan dibulatkan ke bawah menjadi 2023-01-03T11:00:00Z. |
period |
Menunjukkan periode awal dan akhir untuk mendapatkan data perkiraan. Stempel waktu dibulatkan ke jam persis sebelumnya. |
universal_aqi |
Opsional. Jika disetel ke true, AQI Universal akan disertakan dalam kolom 'indexes' respons (default = true). |
language_code |
Opsional. Memungkinkan klien memilih bahasa untuk respons. Jika data tidak dapat diberikan untuk bahasa tersebut, API akan menggunakan kecocokan terdekat. Nilai yang diizinkan bergantung pada standar IETF (default = 'en'). |
LookupForecastResponse
Objek respons API perkiraan kualitas udara.
Kolom | |
---|---|
hourly_forecasts[] |
Opsional. Berisi informasi kualitas udara untuk setiap jam dalam rentang yang diminta. Misalnya, jika permintaannya adalah perkiraan selama 48 jam, akan ada 48 elemen perkiraan per jam. |
region_code |
Opsional. Kode ISO_3166-1 alpha-2 negara/wilayah yang sesuai dengan lokasi yang diberikan dalam permintaan. Kolom ini mungkin dihilangkan dari respons jika lokasi yang diberikan dalam permintaan berada di wilayah yang disengketakan. |
next_page_token |
Opsional. Token untuk mengambil halaman berikutnya. |
HourlyForecast
Berisi informasi kualitas udara untuk setiap jam dalam rentang yang diminta. Misalnya, jika permintaannya adalah perkiraan selama 48 jam, akan ada 48 elemen perkiraan per jam.
Kolom | |
---|---|
date_time |
Stempel waktu yang dibulatkan ke bawah yang menunjukkan waktu (jam) yang dirujuk data dalam format RFC3339 UTC "Zulu". Misalnya: "2014-10-02T15:00:00Z". |
indexes[] |
Berdasarkan parameter permintaan, daftar ini akan menyertakan (maksimal) dua indeks kualitas udara:
|
pollutants[] |
Daftar polutan yang memengaruhi lokasi yang ditentukan dalam permintaan. Catatan: Kolom ini hanya akan ditampilkan untuk permintaan yang menentukan satu atau beberapa komputasi tambahan berikut: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION. |
health_recommendations |
Saran kesehatan dan tindakan yang direkomendasikan terkait kondisi kualitas udara yang dilaporkan. Rekomendasi disesuaikan secara berbeda untuk populasi berisiko, kelompok dengan sensitivitas yang lebih besar terhadap polutan, dan populasi umum. |
LookupHeatmapTileRequest
Permintaan kartu peta panas.
Struktur ini mematuhi panggilan GET server ubin standar, yaitu https://airquality.googleapis.com/v1/mapTypes/{map_type}/heatmapTiles/{zoom}/{x}/{y}
Contoh: https://airquality.googleapis.com/v1/mapTypes/BAQI_INDIGO_PERSIAN/heatmapTiles/1/1/1
Kolom | |
---|---|
map_type |
Wajib. Jenis peta panas kualitas udara. Menentukan polutan yang akan direpresentasikan secara grafis oleh peta.
|
zoom |
Wajib. Tingkat zoom peta. Menentukan seberapa besar atau kecil konten peta yang muncul di tampilan peta. Tingkat zoom 0 adalah seluruh dunia dalam satu ubin. Tingkat zoom 1 adalah seluruh dunia dalam 4 ubin. Tingkat zoom 2 adalah seluruh dunia dalam 16 ubin. Tingkat zoom 16 adalah seluruh dunia dalam 65.536 ubin. Nilai yang diizinkan: 0-16 |
x |
Wajib. Menentukan titik timur-barat di ubin yang diminta. |
y |
Wajib. Menentukan titik utara-selatan di ubin yang diminta. |
LookupHistoryRequest
Objek permintaan API histori kualitas udara.
Kolom | |
---|---|
page_size |
Opsional. Jumlah maksimum data info per jam yang akan ditampilkan per halaman. Defaultnya adalah 72 dan nilai maksimumnya adalah 168 (data 7 hari). |
page_token |
Opsional. Token halaman yang diterima dari panggilan histori sebelumnya. Ini digunakan untuk mengambil halaman berikutnya. Perhatikan bahwa saat memberikan nilai untuk parameter ini, semua parameter lain yang diberikan harus cocok dengan panggilan yang menyediakan token halaman (panggilan sebelumnya). |
location |
Wajib. Lintang dan bujur tempat API mencari data histori kualitas udara. |
extra_computations[] |
Opsional. Fitur tambahan yang dapat diaktifkan secara opsional. Menentukan komputasi tambahan akan menyebabkan elemen dan kolom yang relevan ditampilkan dalam respons. |
uaqi_color_palette |
Opsional. Menentukan palet warna yang digunakan untuk data yang disediakan oleh 'Universal Air Quality Index' (UAQI). Palet warna ini hanya relevan untuk UAQI, AQI lainnya memiliki palet warna yang telah ditentukan sebelumnya dan tidak dapat dikontrol. |
custom_local_aqis[] |
Opsional. Mengekspresikan hubungan 'negara/wilayah ke AQI'. Menyambungkan negara/wilayah dengan AQI yang diinginkan sehingga data kualitas udara yang diperlukan untuk negara/wilayah tersebut akan ditampilkan sesuai dengan AQI yang dipilih. Parameter ini dapat digunakan untuk menentukan AQI non-default untuk negara tertentu, misalnya, untuk mendapatkan indeks EPA Amerika Serikat untuk Kanada, bukan indeks default untuk Kanada. |
Kolom union time_range . Rentang waktu data kualitas udara yang diperlukan. Kegagalan untuk menentukan kolom terkait rentang waktu akan mengakibatkan error INVALID_ARGUMENT. time_range hanya dapat berupa salah satu dari berikut ini: time_range hanya dapat berupa salah satu dari berikut ini: |
|
date_time |
Stempel waktu untuk menampilkan data historis. Stempel waktu dibulatkan ke jam persis sebelumnya. Catatan: tindakan ini hanya akan menampilkan data per jam untuk stempel waktu yang diminta (yaitu satu elemen info per jam). Misalnya, permintaan yang dikirim dengan parameter dateTime ditetapkan ke 2023-01-03T11:05:49Z akan dibulatkan ke bawah menjadi 2023-01-03T11:00:00Z. Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z". |
hours |
Angka dari 1 hingga 720 yang menunjukkan rentang jam untuk permintaan. Misalnya: Nilai 48 akan menghasilkan data dari 48 jam terakhir. |
period |
Menunjukkan periode awal dan akhir untuk mendapatkan data historis. Stempel waktu dibulatkan ke jam persis sebelumnya. |
universal_aqi |
Opsional. Jika disetel ke true, AQI Universal akan disertakan dalam kolom 'indexes' respons. Nilai default adalah true. |
language_code |
Opsional. Memungkinkan klien memilih bahasa untuk respons. Jika data tidak dapat diberikan untuk bahasa tersebut, API akan menggunakan kecocokan terdekat. Nilai yang diizinkan bergantung pada standar IETF. Nilai defaultnya adalah en. |
LookupHistoryResponse
Kolom | |
---|---|
hours_info[] |
Opsional. Berisi informasi kualitas udara untuk setiap jam dalam rentang yang diminta. Misalnya, jika permintaannya adalah untuk histori 48 jam, akan ada 48 elemen info per jam. |
region_code |
Opsional. Kode ISO_3166-1 alpha-2 negara/wilayah yang sesuai dengan lokasi yang diberikan dalam permintaan. Kolom ini mungkin dihilangkan dari respons jika lokasi yang diberikan dalam permintaan berada di wilayah yang disengketakan. |
next_page_token |
Opsional. Token untuk mengambil halaman berikutnya. |
HourInfo
Berisi informasi kualitas udara untuk setiap jam dalam rentang yang diminta. Misalnya, jika permintaannya adalah untuk histori 48 jam, akan ada 48 elemen info per jam.
Kolom | |
---|---|
date_time |
Stempel waktu yang dibulatkan ke bawah yang menunjukkan waktu yang dirujuk data dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Misalnya: "2014-10-02T15:00:00Z". |
indexes[] |
Berdasarkan parameter permintaan, daftar ini akan menyertakan (maksimal) dua indeks kualitas udara:
|
pollutants[] |
Daftar polutan yang memengaruhi lokasi yang ditentukan dalam permintaan. Catatan: Kolom ini hanya akan ditampilkan untuk permintaan yang menentukan satu atau beberapa komputasi tambahan berikut: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION. |
health_recommendations |
Saran kesehatan dan tindakan yang direkomendasikan terkait kondisi kualitas udara yang dilaporkan. Rekomendasi disesuaikan secara berbeda untuk populasi berisiko, kelompok dengan sensitivitas yang lebih besar terhadap polutan, dan populasi umum. |
MapType
Jenis peta panas kualitas udara. Menentukan polutan yang akan direpresentasikan secara grafis oleh peta.
Enum | |
---|---|
MAP_TYPE_UNSPECIFIED |
Nilai default. Server akan mengabaikannya jika diteruskan sebagai parameter. |
UAQI_RED_GREEN |
Palet merah-hijau Indeks Kualitas Udara Universal. |
UAQI_INDIGO_PERSIAN |
Palet indigo-persia Indeks Kualitas Udara Universal. |
PM25_INDIGO_PERSIAN |
Indeks PM2.5 palet indigo-persia. |
GBR_DEFRA |
Palet warna Indeks Kualitas Udara Harian (Inggris Raya). |
DEU_UBA |
Palet warna Indeks Kualitas Udara Lokal Jerman. |
CAN_EC |
Palet warna Indeks Kesehatan Kualitas Udara Kanada. |
FRA_ATMO |
Palet warna Indeks Kualitas Udara Prancis. |
US_AQI |
Palet warna Indeks Kualitas Udara Amerika Serikat. |
Polutan
Data terkait polutan kualitas udara.
Kolom | |
---|---|
code |
Nama kode polutan (misalnya, "so2"). Untuk mengetahui daftar kode polutan yang didukung, lihat Polutan yang dilaporkan. |
display_name |
Nama tampilan polutan. Misalnya: "NOx". |
full_name |
Nama lengkap polutan. Untuk senyawa kimia, ini adalah nama IUPAC. Contoh: "Sulfur Dioxide". Untuk informasi selengkapnya tentang tabel nama IUPAC, lihat https://iupac.org/what-we-do/periodic-table-of-elements/. |
concentration |
Tingkat konsentrasi polutan yang diukur dengan salah satu satuan pengukuran polusi udara standar. |
additional_info |
Informasi tambahan tentang polutan. |
AdditionalInfo
Sumber emisi dan efek kesehatan dari polutan tertentu.
Kolom | |
---|---|
sources |
Teks yang mewakili sumber emisi utama polutan. |
effects |
Teks yang mewakili efek kesehatan utama polutan. |
Konsentrasi
Konsentrasi polutan tertentu di udara.
Kolom | |
---|---|
units |
Satuan untuk mengukur konsentrasi polutan ini. |
value |
Nilai konsentrasi polutan. |
Unit
Menentukan satuan yang digunakan untuk mengukur konsentrasi polutan. Untuk menentukan satuan konsentrasi default bagi polutan tertentu, lihat tabel di Polutan yang dilaporkan.
Enum | |
---|---|
UNIT_UNSPECIFIED |
Unit konsentrasi tidak ditentukan. |
PARTS_PER_BILLION |
Satuan konsentrasi ppb (bagian per miliar). |
MICROGRAMS_PER_CUBIC_METER |
Satuan konsentrasi "µg/m^3" (mikrogram per meter kubik). |