LookupWeatherResponse

Response for the LookupWeather RPC - represents the weather conditions at the requested location.

This response represent both Hourly and Daily information, therefore the response is split in three sections Hourly, Daily and Shared. Only-Hourly, Only-Daily fields are marked as optional. For fields that are shared between Hourly and Daily information, some are always present so they are not marked as optional while the rest are marked as optional because they are not always available.

JSON representation
{
  "weatherCondition": {
    object (WeatherCondition)
  },
  "precipitation": {
    object (Precipitation)
  },
  "wind": {
    object (Wind)
  },
  "returnedLocation": {
    object (Location)
  },
  "attribution": {
    object (Attribution)
  },
  "temperature": {
    object (Temperature)
  },
  "feelsLikeTemperature": {
    object (Temperature)
  },
  "heatIndex": {
    object (Temperature)
  },
  "airPressure": {
    object (AirPressure)
  },
  "maxTemperature": {
    object (Temperature)
  },
  "minTemperature": {
    object (Temperature)
  },
  "feelsLikeMaxTemperature": {
    object (Temperature)
  },
  "feelsLikeMinTemperature": {
    object (Temperature)
  },
  "maxHeatIndex": {
    object (Temperature)
  },
  "sunEvents": {
    object (SunEvents)
  },
  "moonEvents": {
    object (MoonEvents)
  },
  "relativeHumidity": integer,
  "uvIndex": integer,
  "thunderstormProbability": integer,
  "cloudCover": integer,
  "weather": {
    object (WeatherResultData)
  },
  "airQuality": {
    object (AirQualityResultData)
  },
  "pollen": {
    object (PollenResultData)
  },
  "timeZone": string
}
Fields
weatherCondition

object (WeatherCondition)

The weather condition

precipitation

object (Precipitation)

The precipitation probability and amount of precipitation accumulated

wind

object (Wind)

The wind conditions

returnedLocation

object (Location)

Required. The location where the weather information is returned. This location is identical to the location in the request, but can be different from it if the requested location is a free text address that looks up to a coarse location (e.g. "Mountain View, CA").

attribution

object (Attribution)

Required attribution to show with the weather.

temperature

object (Temperature)

The hourly temperature

feelsLikeTemperature

object (Temperature)

The hourly measure of how the temperature feels like.

heatIndex

object (Temperature)

The hourly heat index temperature.

airPressure

object (AirPressure)

The hourly air pressure conditions.

maxTemperature

object (Temperature)

The maximum (high) temperature throughout the day.

minTemperature

object (Temperature)

The minimum (low) temperature throughout the day.

feelsLikeMaxTemperature

object (Temperature)

The maximum (high) feels-like temperature throughout the day.

feelsLikeMinTemperature

object (Temperature)

The minimum (low) feels-like temperature throughout the day.

maxHeatIndex

object (Temperature)

The maximum heat index temperature throughout the day.

sunEvents

object (SunEvents)

The events related to the sun (e.g. sunrise, sunset).

moonEvents

object (MoonEvents)

The events related to the moon (e.g. moonrise, moonset).

relativeHumidity

integer

The percent of relative humidity (values from 0 to 100).

uvIndex

integer

The maximum ultraviolet (UV) index.

thunderstormProbability

integer

The thunderstorm probability (values from 0 to 100).

cloudCover

integer

The percentage of the sky covered by clouds (values from 0 to 100).

weather

object (WeatherResultData)

Weather conditions at the requested location.

airQuality

object (AirQualityResultData)

Air quality information at the requested location.

pollen

object (PollenResultData)

Pollen information at the requested location.

timeZone

string

Resolved IANA timezone string for the location (e.g., "America/New_York", "Asia/Tokyo").

Temperature

Represents a temperature value.

JSON representation
{
  "unit": enum (Unit),
  "degrees": number
}
Fields
unit

enum (Unit)

Optional. The code for the unit used to measure the temperature value.

degrees

number

The temperature value (in degrees) in the specified unit.

SunEvents

Represents the events related to the sun (e.g. sunrise, sunset).

JSON representation
{
  "sunriseTime": string,
  "sunsetTime": string
}
Fields
sunriseTime

string (Timestamp format)

The time when the sun rises.

NOTE: In some unique cases (e.g. north of the artic circle) there may be no sunrise time for a day. In these cases, this field will be unset.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

sunsetTime

string (Timestamp format)

The time when the sun sets.

NOTE: In some unique cases (e.g. north of the artic circle) there may be no sunset time for a day. In these cases, this field will be unset.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

MoonEvents

Represents the events related to the moon (e.g. moonrise, moonset).

JSON representation
{
  "moonPhase": enum (Phase),
  "moonriseTimes": [
    string
  ],
  "moonsetTimes": [
    string
  ]
}
Fields
moonPhase

enum (Phase)

Optional. The moon phase (a.k.a. lunar phase).

moonriseTimes[]

string (Timestamp format)

The time when the upper limb of the moon appears above the horizon (see https://en.wikipedia.org/wiki/Moonrise_and_moonset).

NOTE: For most cases, there'll be a single moon rise time per day. In other cases, the list might be empty (e.g. when the moon rises after next day midnight). However, in unique cases (e.g. in polar regions), the list may contain more than one value. In these cases, the values are sorted in ascending order.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

moonsetTimes[]

string (Timestamp format)

The time when the upper limb of the moon disappears below the horizon (see https://en.wikipedia.org/wiki/Moonrise_and_moonset).

NOTE: For most cases, there'll be a single moon set time per day. In other cases, the list might be empty (e.g. when the moon sets after next day midnight). However, in unique cases (e.g. in polar regions), the list may contain more than one value. In these cases, the values are sorted in ascending order.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

WeatherCondition

Represents a weather condition for a given location at a given period of time.

Disclaimer: Weather icons and condition codes are subject to change. Google may introduce new codes and icons or update existing ones as needed. We encourage you to refer to this documentation regularly for the most up-to-date information.

JSON representation
{
  "iconBaseUri": string,
  "description": {
    object (LocalizedText)
  },
  "type": enum (Type)
}
Fields
iconBaseUri

string

The base URI for the icon not including the file type extension. To display the icon, append a theme if desired and the file type extension (.png or .svg) to this URI. By default, the icon is light themed, but _dark can be appended for dark mode. For example: "https://maps.gstatic.com/weather/v1/dust.svg" or "https://maps.gstatic.com/weather/v1/dust_dark.svg", where iconBaseUri is "https://maps.gstatic.com/weather/v1/dust".

description

object (LocalizedText)

The textual description for this weather condition (localized).

type

enum (Type)

The type of weather condition.

LocalizedText

Localized variant of a text in a particular language.

JSON representation
{
  "text": string,
  "languageCode": string
}
Fields
text

string

Localized string in the language corresponding to languageCode below.

languageCode

string

The text's BCP-47 language code, such as "en-US" or "sr-Latn".

For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

Precipitation

Represents a set of precipitation values at a given location.

JSON representation
{
  "probability": {
    object (PrecipitationProbability)
  },
  "snowQpf": {
    object (QuantitativePrecipitationForecast)
  },
  "qpf": {
    object (QuantitativePrecipitationForecast)
  }
}
Fields
probability

object (PrecipitationProbability)

The probability of precipitation (values from 0 to 100).

snowQpf

object (QuantitativePrecipitationForecast)

The amount of snow, measured as liquid water equivalent, that has accumulated over a period of time. Note: QPF is an abbreviation for Quantitative Precipitation Forecast (please see the QuantitativePrecipitationForecast definition for more details).

qpf

object (QuantitativePrecipitationForecast)

The amount of precipitation rain, measured as liquid water equivalent, that has accumulated over a period of time. Note: QPF is an abbreviation for Quantitative Precipitation Forecast (please see the QuantitativePrecipitationForecast definition for more details).

PrecipitationProbability

Represents the probability of precipitation at a given location.

JSON representation
{
  "type": enum (Type),
  "percent": integer
}
Fields
type

enum (Type)

Optional. A code that indicates the type of precipitation.

percent

integer

A percentage from 0 to 100 that indicates the chances of precipitation.

QuantitativePrecipitationForecast

Represents the expected amount of melted precipitation accumulated over a specified time period over a specified area (reference: https://en.wikipedia.org/wiki/Quantitative_precipitation_forecast) - usually abbreviated QPF for short.

JSON representation
{
  "unit": enum (Unit),
  "quantity": number
}
Fields
unit

enum (Unit)

The code of the unit used to measure the amount of accumulated precipitation.

quantity

number

The amount of precipitation, measured as liquid water equivalent, that has accumulated over a period of time.

Wind

Represents a set of wind properties.

JSON representation
{
  "direction": {
    object (WindDirection)
  },
  "speed": {
    object (WindSpeed)
  },
  "gust": {
    object (WindSpeed)
  }
}
Fields
direction

object (WindDirection)

The direction of the wind, the angle it is coming from.

speed

object (WindSpeed)

The speed of the wind.

gust

object (WindSpeed)

The wind gust (sudden increase in the wind speed).

WindDirection

Represents the direction from which the wind originates.

JSON representation
{
  "cardinal": enum (Cardinal),
  "degrees": integer
}
Fields
cardinal

enum (Cardinal)

Optional. The code that represents the cardinal direction from which the wind is blowing.

degrees

integer

The direction of the wind in degrees (values from 0 to 360).

WindSpeed

Represents the speed of the wind.

JSON representation
{
  "unit": enum (Unit),
  "value": number
}
Fields
unit

enum (Unit)

Optional. The code that represents the unit used to measure the wind speed.

value

number

The value of the wind speed.

WeatherResultData

Weather conditions payload for the requested location.

JSON representation
{
  "weatherCondition": {
    object (WeatherCondition)
  },
  "precipitation": {
    object (Precipitation)
  },
  "wind": {
    object (Wind)
  },
  "attribution": {
    object (Attribution)
  },
  "dateTime": string,
  "temperature": {
    object (Temperature)
  },
  "feelsLikeTemperature": {
    object (Temperature)
  },
  "heatIndex": {
    object (Temperature)
  },
  "airPressure": {
    object (AirPressure)
  },
  "date": {
    object (Date)
  },
  "maxTemperature": {
    object (Temperature)
  },
  "minTemperature": {
    object (Temperature)
  },
  "feelsLikeMaxTemperature": {
    object (Temperature)
  },
  "feelsLikeMinTemperature": {
    object (Temperature)
  },
  "maxHeatIndex": {
    object (Temperature)
  },
  "sunEvents": {
    object (SunEvents)
  },
  "moonEvents": {
    object (MoonEvents)
  },
  "relativeHumidity": integer,
  "uvIndex": integer,
  "thunderstormProbability": integer,
  "cloudCover": integer
}
Fields
weatherCondition

object (WeatherCondition)

The weather condition.

precipitation

object (Precipitation)

The precipitation probability and amount of precipitation accumulated.

wind

object (Wind)

The wind conditions.

attribution

object (Attribution)

Required attribution to show with the weather.

dateTime

string (Timestamp format)

The timestamp for this hourly or current weather entry.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

temperature

object (Temperature)

The hourly temperature.

feelsLikeTemperature

object (Temperature)

The hourly measure of how the temperature feels like.

heatIndex

object (Temperature)

The hourly heat index temperature.

airPressure

object (AirPressure)

The hourly air pressure conditions.

date

object (Date)

Civil calendar date of the daily weather forecast.

maxTemperature

object (Temperature)

The maximum (high) temperature throughout the day.

minTemperature

object (Temperature)

The minimum (low) temperature throughout the day.

feelsLikeMaxTemperature

object (Temperature)

The maximum (high) feels-like temperature throughout the day.

feelsLikeMinTemperature

object (Temperature)

The minimum (low) feels-like temperature throughout the day.

maxHeatIndex

object (Temperature)

The maximum heat index temperature throughout the day.

sunEvents

object (SunEvents)

The events related to the sun (e.g. sunrise, sunset).

moonEvents

object (MoonEvents)

The events related to the moon (e.g. moonrise, moonset).

relativeHumidity

integer

The percent of relative humidity (values from 0 to 100).

uvIndex

integer

The maximum ultraviolet (UV) index.

thunderstormProbability

integer

The thunderstorm probability (values from 0 to 100).

cloudCover

integer

The percentage of the sky covered by clouds (values from 0 to 100).

PollenResultData

Pollen payload for the requested location.

JSON representation
{
  "dailyForecast": {
    object (DailyPollenForecast)
  },
  "attribution": {
    object (Attribution)
  }
}
Fields
dailyForecast

object (DailyPollenForecast)

Daily pollen forecast for the requested date.

attribution

object (Attribution)

Required attribution to show with the pollen data.

DailyPollenForecast

Pollen forecast for a single calendar day.

JSON representation
{
  "date": {
    object (Date)
  },
  "categories": [
    {
      object (PollenCategoryInfo)
    }
  ],
  "plantSpecies": [
    {
      object (PlantSpeciesInfo)
    }
  ]
}
Fields
date

object (Date)

Civil calendar date of the forecast.

categories[]

object (PollenCategoryInfo)

Broad pollen category breakdown (Tree, Grass, Weed).

plantSpecies[]

object (PlantSpeciesInfo)

Granular plant species breakdown.

PollenCategoryInfo

Information for a broad pollen category (e.g. Tree, Grass, Weed).

JSON representation
{
  "displayName": string,
  "inSeason": boolean,
  "index": {
    object (PollenIndex)
  },
  "healthRecommendations": [
    string
  ]
}
Fields
displayName

string

Display name of the category (e.g. "Tree", "Grass", "Weed").

inSeason

boolean

Whether this pollen category is actively blooming in the region.

index

object (PollenIndex)

Universal Pollen Index (UPI) measurement for this category.

healthRecommendations[]

string

Actionable health advice for pollen-sensitive groups.

PollenIndex

Standardized Universal Pollen Index (UPI) measurement.

JSON representation
{
  "category": string,
  "description": string,
  "value": integer
}
Fields
category

string

Localized category classification (e.g. "None", "Very Low", "Low", "Moderate", "High", "Very High").

description

string

Description of the pollen risk level.

value

integer

Numeric UPI value (0 to 5 scale).

PlantSpeciesInfo

Information for a specific allergenic plant species.

JSON representation
{
  "code": string,
  "displayName": string,
  "family": string,
  "inSeason": boolean,
  "index": {
    object (PollenIndex)
  },
  "season": string,
  "crossReactions": string
}
Fields
code

string

Machine-readable species code (e.g. "BIRCH", "JAPANESE_CEDAR", "RAGWEED").

displayName

string

Localized display name of the plant species (e.g. "Birch").

family

string

Botanical family name (e.g. "Betulaceae (the Birch family)").

inSeason

boolean

Whether this plant species is currently in season.

index

object (PollenIndex)

Universal Pollen Index (UPI) measurement for this species.

season

string

Typical blooming season description (e.g. "Late winter, spring").

crossReactions

string

Known cross-reactive allergens (e.g. "Alder, Hazel, Beech, and Oak pollen").