Method: history.lookup

Belirli bir zaman aralığında belirli bir konumun hava kalitesi geçmişini döndürür.

HTTP isteği

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

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

İstek içeriği

İstek gövdesi, aşağıdaki yapıyla birlikte veriler içerir:

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

integer

İsteğe bağlı. Sayfa başına döndürülecek maksimum saatlik bilgi kaydı sayısı. Varsayılan değer 72, maksimum değer ise 168'dir (7 günlük veri).
pageToken

string

İsteğe bağlı. Önceki bir geçmiş çağrısından alınan sayfa jetonu. Sonraki sayfayı getirmek için kullanılır.

Bu parametre için bir değer sağlarken sağlanan diğer tüm parametrelerin, sayfa jetonunu sağlayan çağrıyla (önceki çağrı) eşleşmesi gerektiğini unutmayın.
location

object (LatLng)

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

enum (ExtraComputation)

İsteğe bağlı. İsteğe bağlı olarak etkinleştirilebilen ek özellikler. Ek hesaplamaların belirtilmesi, ilgili öğelerin ve alanların yanıtta 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 ile alakalıyken diğer HKİ'lerin kontrol edilemeyen, önceden belirlenmiş renk paleti vardır.
customLocalAqis[]

object (CustomLocalAqi)

İsteğe bağlı. "Ülke/bölge ile HKİ" ilişkisi ifade eder. Bir ülkeyi/bölgeyi istenen HKİ ile eşleyerek o ülke/bölge için gerekli olan hava kalitesi verilerinin seçilen HKİ'ye göre görüntülenmesini sağlar. Bu parametre, belirli bir ülke için varsayılan olmayan bir HKİ belirtmek amacıyla (örneğin, Kanada için varsayılan dizin yerine Kanada için ABD EPA dizinini almak amacıyla) kullanılabilir.
time_range alanı. Gerekli hava kalitesi verilerinin zaman aralığı. Zaman aralığıyla ilgili herhangi bir alanın belirtilmemesi INVALID_ARGUMENT hatasına neden olur. Zaman_aralığı aşağıdakilerden yalnızca biri olabilir: time_range, aşağıdakilerden yalnızca biri olabilir:
dateTime

string (Timestamp format)

Geçmiş verilerin döndürüleceği zaman damgası. Zaman damgası önceki tam saate yuvarlanır.

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

Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
hours

integer

İsteğin saat aralığını gösteren 1 ile 720 arasında bir sayı. Örneğin: 48 değeri, son 48 saate ait verileri verir.
period

object (Interval)

Geçmiş verilerinin alınacağı başlangıç ve bitiş dönemini belirtir. Zaman damgası önceki tam saate yuvarlanır.
universalAqi

boolean

İsteğe bağlı. Doğru değerine ayarlanırsa Evrensel HKİ, yanıtın "dizinler" alanına eklenir. Varsayılan değer, doğru değeridir.
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ı kullanır. Varsayılan değer İngilizce'dir (en).

Yanıt gövdesi

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

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

object (HourInfo)

İsteğe bağlı. İstenen aralıktaki her saat için hava kalitesi bilgilerini içerir. Örneğin, istek 48 saatlik geçmişe yönelikse saatlik bilginin 48 öğesi olacaktır.
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 bulunuyorsa 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.

Aralık

Zaman damgası başlangıcı (dahil) ve zaman damgası sonu (hariç) olarak kodlanan bir zaman aralığını temsil eder.

Başlangıç, bitişten küçük veya sona eşit olmalıdır. Başlangıç bitişi olduğunda aralık boş olur (zamanla eşleşmez). Hem başlangıç hem de bitiş belirtilmezse aralık herhangi bir zamanla eşleşir.

JSON gösterimi 
{
  "startTime": string,
  "endTime": string
}
Alanlar
startTime

string (Timestamp format)

İsteğe bağlı. Aranın kapsayıcı başlangıcı.

Belirtilirse bu aralıkla eşleşen bir Zaman Damgası, başlangıç ile aynı veya daha sonra olmalıdır.
endTime

string (Timestamp format)

İsteğe bağlı. Aralığın dışlayıcı sonu.

Belirtilirse bu aralıkla eşleşen bir Zaman Damgası bitişten önce olmalıdır.

HourInfo

İstenen aralıktaki her saat için hava kalitesi bilgilerini içerir. Örneğin, istek 48 saatlik geçmişe yönelikse saatlik bilginin 48 öğesi olacaktır.

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 gösteren, nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağa sahip, aşağı doğru yuvarlanmış zaman damgası. Örneğin: "2014-10-02T15:00:00Z".
indexes[]

object (AirQualityIndex)

İstek parametrelerine bağlı olarak bu liste (en fazla) iki hava kalitesi indeks içerir:

  • 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 koşullarıyla ilgili sağlık önerileri ve önerilen işlemler. Risk altındaki kişiler, kirliliğe yol açan maddelere karşı daha hassas olan gruplar ve genel popülasyon için öneriler farklı şekilde özelleştirilir.