Method: forecast.lookup

지정된 기간 동안 특정 위치의 공기질 예보를 반환합니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 구문을 사용합니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

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
}
필드
location

object (LatLng)

필수 항목입니다. API가 공기질 데이터를 찾는 위도 및 경도입니다.
extraComputations[]

enum (ExtraComputation)

선택사항입니다. 선택적으로 사용 설정할 수 있는 추가 기능입니다. 추가 계산을 지정하면 관련 요소와 필드가 응답에 반환됩니다.
uaqiColorPalette

enum (ColorPalette)

선택사항입니다. '세계 공기질 지수'에서 제공하는 데이터에 사용되는 색상 팔레트를 결정합니다. (UAQI). 이 색상 팔레트는 UAQI에만 해당하며, 다른 AQI에는 제어할 수 없는 미리 정해진 색상 팔레트가 있습니다.
customLocalAqis[]

object (CustomLocalAqi)

선택사항입니다. '국가/지역을 AQI로' 표현 관계입니다. 해당 국가/지역에 필요한 공기질 데이터가 선택한 AQI에 따라 표시되도록 국가/지역을 원하는 AQI와 페어링합니다. 이 매개변수를 사용하여 특정 국가에 대해 기본값이 아닌 AQI를 지정할 수 있습니다. 예를 들어 캐나다의 기본 지수가 아닌 캐나다의 미국 EPA 지수를 구하려는 경우입니다.
pageSize

integer

선택사항입니다. 페이지당 반환할 시간별 정보 레코드의 최대 개수입니다 (기본값 = 24).
pageToken

string

선택사항입니다. 이전 예측 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하는 데 사용됩니다.
dateTime

string (Timestamp format)

특정 시점의 데이터를 반환할 타임스탬프입니다. 타임스탬프는 정확한 이전 시간으로 반올림됩니다.

요청된 타임스탬프에 해당하는 시간별 데이터만 반환됩니다 (예: 단일 시간별 정보 요소). 예를 들어 dateTime 매개변수가 2023-01-03T11:05:49Z로 설정된 상태에서 전송된 요청은 2023-01-03T11:00:00Z로 반내림됩니다.

참고: 요청에 dateTime 또는 startTime 및 endTime를 사용할 수 있습니다.
period

object (Interval)

예측 데이터를 가져올 startTime 및 endTime 기간을 나타냅니다. endTime이 포함됩니다. 타임스탬프는 정확한 이전 시간으로 반올림됩니다.

참고: 요청에 dateTime 또는 startTime 및 endTime를 사용할 수 있습니다.
universalAqi

boolean

선택사항입니다. true로 설정하면 범용 AQI가 '색인'에 포함됩니다. 필드 값으로 사용됩니다 (기본값 = true).
languageCode

string

선택사항입니다. 클라이언트가 응답의 언어를 선택할 수 있도록 합니다. 해당 언어에 대한 데이터를 제공할 수 없는 경우 API는 가장 가까운 일치 항목을 사용합니다. 허용되는 값은 IETF 표준 (기본값 = 'en')에 따라 달라집니다.

응답 본문

공기질 예보 API의 응답 객체입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
필드
hourlyForecasts[]

object (HourlyForecast)

선택사항입니다. 요청한 범위 내의 시간별 공기질 정보가 포함됩니다. 예를 들어 48시간의 예측에 대한 요청의 경우 시간별 예측에는 48개 요소가 포함됩니다.
regionCode

string

선택사항입니다. 요청에 제공된 위치에 해당하는 국가/지역의 ISO_3166-1 alpha-2 코드입니다. 요청에 제공된 위치가 분쟁 지역 내에 있는 경우 응답에서 이 필드가 생략될 수 있습니다.
nextPageToken

string

선택사항입니다. 다음 페이지를 검색하기 위한 토큰입니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.

HourlyForecast

요청한 범위 내의 시간별 공기질 정보가 포함됩니다. 예를 들어 48시간의 예측에 대한 요청의 경우 시간별 예측에는 48개 요소가 포함됩니다.

JSON 표현 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
필드
dateTime

string (Timestamp format)

RFC3339 UTC 'Zulu'에서 데이터가 참조하는 시간 (시간)을 나타내는 내림된 타임스탬프입니다. 형식으로 입력합니다. 예: '2014-10-02T15:00:00Z'
indexes[]

object (AirQualityIndex)

요청 매개변수에 따라 이 목록에는 최대 2개의 공기질 지수가 포함됩니다.

  • 범용 AQI입니다. universalAqi 부울이 true로 설정된 경우 반환됩니다.
  • 로컬 AQI LOCAL_AQI 추가 계산이 지정된 경우 반환됩니다.
pollutants[]

object (Pollutant)

요청에 지정된 위치에 영향을 미치는 오염 물질 목록입니다.

참고: 이 필드는 추가 계산(POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION) 중 하나 이상을 지정한 요청에 대해서만 반환됩니다.
healthRecommendations

object (HealthRecommendations)

보고된 공기질 상태와 관련된 건강 관련 조언 및 권장 조치입니다. 위험군, 오염 물질에 민감도가 더 높은 그룹, 일반 인구에 따라 다른 방식으로 권장사항이 조정됩니다.