Method: forecast.lookup

Belirli bir zaman aralığında belirli bir konumla ilgili hava kalitesi tahminini döndürür.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek içeriği

İsteğin gövdesi, aşağıdaki yapıya sahip veriler içerir:

JSON gösterimi 
{
  "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
}
Alanlar
location

object (LatLng)

Zorunlu. API'nin hava kalitesi verilerini aradığı enlem ve boylam.
extraComputations[]

enum (ExtraComputation)

İsteğe bağlı. İsteğe bağlı olarak etkinleştirilebilen ek özellikler. Fazladan hesaplamaların belirtilmesi, yanıtta ilgili öğelerin ve alanların döndürülmesiyle sonuçlanır.
uaqiColorPalette

enum (ColorPalette)

İsteğe bağlı. "Evrensel Hava Kalitesi İndeksi" (UAQI) tarafından sağlanan veriler için kullanılan renk paletini belirler. Bu renk paleti yalnızca UAQI için geçerlidir, diğer AQI'lerin kontrol edilemeyen önceden belirlenmiş bir renk paleti vardır.
customLocalAqis[]

object (CustomLocalAqi)

İsteğe bağlı. "Ülke/bölge ile HKİ arasında" ilişkisini ifade eder. Bir ülkeyi/bölgeyi, istenen bir HKİ ile eşler. Böylece o ülke/bölge için gerekli olan hava kalitesi verileri, seçilen HKİ'ye göre görüntülenir. Bu parametre, belirli bir ülke için varsayılan olmayan bir HKİ belirlemek amacıyla (örneğin, Kanada için varsayılan dizin yerine Kanada için ABD EPA endeksini almak amacıyla) kullanılabilir.
pageSize

integer

İsteğe bağlı. Sayfa başına döndürülecek maksimum saatlik bilgi kaydı sayısı (varsayılan = 24).
pageToken

string

İsteğe bağlı. Önceki bir tahmin çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için kullanılır.
dateTime

string (Timestamp format)

Belirli bir zamana ait verilerin döndürüleceği zaman damgası. Zaman damgası, önceki tam saate yuvarlanır.

Bu, yalnızca istenen zaman damgası için saatlik verileri döndürür (ör. tek bir saatlik bilgi öğesi). Örneğin, dateTime parametresinin 2023-01-03T11:05:49Z olarak ayarlandığı bir istek, 2023-01-03T11:00:00Z değerine yuvarlanır.

Not: Bir istekte dateTime veya startTime ve endTime kullanılabilir.
period

object (Interval)

Tahmin verilerinin alınacağı startTime ve endTime dönemini belirtir. endTime kapsayıcıdır. Zaman damgası, önceki tam saate yuvarlanır.

Not: Bir istekte dateTime veya startTime ve endTime kullanılabilir.
universalAqi

boolean

İsteğe bağlı. Doğru değerine ayarlanırsa Evrensel HKİ, yanıtın "dizinler" alanına eklenir (varsayılan = doğru).
languageCode

string

İsteğe bağlı. İstemcinin yanıtın dilini seçmesine olanak tanır. Bu dil için veri sağlanamazsa API en yakın eşleşmeyi kullanır. İzin verilen değerler IETF standardını temel alır (varsayılan = 'en').

Yanıt gövdesi

Hava kalitesi tahmin API'sinin yanıt nesnesi.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
Alanlar
hourlyForecasts[]

object (HourlyForecast)

İsteğe bağlı. İstenen aralıktaki her saat için hava kalitesi bilgilerini içerir. Örneğin, istek 48 saatlik tahmin içinse 48 saatlik tahmin öğesi olur.
regionCode

string

İsteğe bağlı. İstekte sağlanan konuma karşılık gelen ülkenin/bölgenin ISO_3166-1 alfa-2 kodu. İstekte belirtilen konum ihtilaflı bir bölgede yer alıyorsa bu alan yanıttan çıkarılabilir.
nextPageToken

string

İsteğe bağlı. Sonraki sayfayı almak için kullanılan jeton.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.

HourlyForecast

İstenen aralıktaki her saat için hava kalitesi bilgilerini içerir. Örneğin, istek 48 saatlik tahmin içinse 48 saatlik tahmin öğesi olur.

JSON gösterimi 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Alanlar
dateTime

string (Timestamp format)

Verilerin RFC3339 UTC "Zulu" biçiminde ifade ettiği saati (saat) gösteren aşağı yuvarlanmış zaman damgası. Örneğin: "2014-10-02T15:00:00Z".
indexes[]

object (AirQualityIndex)

İstek parametrelerine göre bu listede (en fazla) iki hava kalitesi endeksi yer alır:

  • Evrensel HKİ. universalAqi boole değeri doğru değerine ayarlanırsa döndürülür.
  • Yerel HKİ. LOCAL_AQI ekstra hesaplama belirtilirse döndürülür.
pollutants[]

object (Pollutant)

İstekte belirtilen konumu etkileyen kirliliğe yol açan maddelerin listesi.

Not: Bu alan yalnızca şu ekstra hesaplamalardan birini veya daha fazlasını belirten istekler için döndürülür: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
healthRecommendations

object (HealthRecommendations)

Bildirilen hava kalitesi durumuyla ilgili sağlık önerileri ve önerilen işlemler. Öneriler risk altındaki nüfus, kirliliğe yol açan maddelere daha fazla duyarlı olan gruplar ve genel popülasyon için farklı şekilde özelleştirilir.