Method: forecast.lookup

Menampilkan perkiraan kualitas udara di lokasi tertentu selama rentang waktu tertentu.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "pageSize": integer,
  "pageToken": string,
  "dateTime": string,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
Kolom
location

object (LatLng)

Wajib. Lintang dan bujur yang data kualitas udaranya dicari API.
extraComputations[]

enum (ExtraComputation)

Opsional. Fitur tambahan yang dapat diaktifkan secara opsional. Menentukan komputasi tambahan akan menghasilkan elemen dan kolom yang relevan untuk ditampilkan dalam respons.
uaqiColorPalette

enum (ColorPalette)

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 yang tidak dapat dikontrol.
customLocalAqis[]

object (CustomLocalAqi)

Opsional. Menyatakan 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 AS untuk Kanada, bukan indeks default untuk Kanada.
pageSize

integer

Opsional. Jumlah maksimum data info per jam yang akan ditampilkan per halaman (default = 24).
pageToken

string

Opsional. Token halaman diterima dari panggilan perkiraan sebelumnya. Ini digunakan untuk mengambil halaman berikutnya.
dateTime

string (Timestamp format)

Stempel waktu yang digunakan untuk menampilkan data pada titik waktu tertentu. Stempel waktu dibulatkan ke jam persis sebelumnya.

Tindakan ini akan menampilkan data per jam untuk stempel waktu yang diminta saja (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.

Catatan: dateTime atau startTime dan endTime dapat digunakan dalam permintaan.
period

object (Interval)

Menunjukkan periode startTime dan endTime yang digunakan untuk mendapatkan data perkiraan. endTime bersifat inklusif. Stempel waktu dibulatkan ke jam persis sebelumnya.

Catatan: dateTime atau startTime dan endTime dapat digunakan dalam permintaan.
universalAqi

boolean

Opsional. Jika ditetapkan ke true, AQI Universal akan disertakan dalam kolom 'indeks' respons (default = true).
languageCode

string

Opsional. Memungkinkan klien memilih bahasa untuk respons. Jika data tidak dapat diberikan untuk bahasa tersebut, API akan menggunakan bahasa terdekat yang cocok. Nilai yang diizinkan bergantung pada standar IETF (default = 'en').

Isi respons

Objek respons API perkiraan kualitas udara.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
Kolom
hourlyForecasts[]

object (HourlyForecast)

Opsional. Berisi informasi kualitas udara untuk setiap jam dalam rentang yang diminta. Misalnya, jika permintaan berupa perkiraan selama 48 jam, akan ada 48 elemen perkiraan per jam.
regionCode

string

Opsional. Kode ISO_3166-1 alpha-2 untuk negara/wilayah yang sesuai dengan lokasi yang diberikan dalam permintaan. Kolom ini mungkin dihapus dari respons jika lokasi yang diberikan dalam permintaan berada di wilayah sengketa.
nextPageToken

string

Opsional. Token untuk mengambil halaman berikutnya.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

HourlyForecast

Berisi informasi kualitas udara untuk setiap jam dalam rentang yang diminta. Misalnya, jika permintaan berupa perkiraan selama 48 jam, akan ada 48 elemen perkiraan per jam.

Representasi JSON 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Kolom
dateTime

string (Timestamp format)

Stempel waktu yang dibulatkan ke bawah menunjukkan waktu (jam) yang dirujuk data dalam format "Zulu" RFC3339 UTC. Misalnya: "2014-10-02T15:00:00Z".
indexes[]

object (AirQualityIndex)

Berdasarkan parameter permintaan, daftar ini akan mencakup (hingga) dua indeks kualitas udara:

  • AQI Universal. Akan ditampilkan jika boolean universalAqi ditetapkan ke benar (true).
  • AQI lokal. Akan dikembalikan jika komputasi tambahan LOCAL_AQI ditentukan.
pollutants[]

object (Pollutant)

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.
healthRecommendations

object (HealthRecommendations)

Saran kesehatan dan tindakan yang disarankan terkait kondisi kualitas udara yang dilaporkan. Rekomendasi disesuaikan secara berbeda untuk populasi yang berisiko, kelompok dengan sensitivitas lebih besar terhadap polutan, dan populasi umum.