Package google.maps.pollen.v1

Index

Pollen (interface)
Index (enum)
IndexInfo (message)
LookupForecastRequest (message)
LookupForecastResponse (message)
LookupForecastResponse.DayInfo (message)
LookupHeatmapTileRequest (message)
LookupHeatmapTileRequest.MapType (enum)
Plant (enum)
PlantDescription (message)
PlantInfo (message)
PollenType (enum)
PollenTypeInfo (message)

Pollen

Service definition for the Pollen API.

LookupForecast

LookupForecast
`rpc LookupForecast(LookupForecastRequest) returns (LookupForecastResponse)` Returns up to 5 days of daily pollen information in more than 65 countries, up to 1km resolution. Authorization scopes Requires the following OAuth scope: `https://www.googleapis.com/auth/cloud-platform` For more information, see the OAuth 2.0 Overview.

rpc LookupForecast(LookupForecastRequest) returns (LookupForecastResponse)

Returns up to 5 days of daily pollen information in more than 65 countries, up to 1km resolution.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

LookupHeatmapTile

LookupHeatmapTile
`rpc LookupHeatmapTile(LookupHeatmapTileRequest) returns (HttpBody)` Returns a byte array containing the data of the tile PNG image. Authorization scopes Requires the following OAuth scope: `https://www.googleapis.com/auth/cloud-platform` For more information, see the OAuth 2.0 Overview.

rpc LookupHeatmapTile(LookupHeatmapTileRequest) returns (HttpBody)

Returns a byte array containing the data of the tile PNG image.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

Index

Index Code

Enums
`INDEX_UNSPECIFIED`	Unspecified index.
`UPI`	Universal Pollen Index.

IndexInfo

This object contains data representing specific pollen index value, category and description.

Fields
`code`	`Index` The index's code. This field represents the index for programming purposes by using snake cases instead of spaces. Example: "UPI".
`display_name`	`string` A human readable representation of the index name. Example: "Universal Pollen Index".
`category`	`string` Text classification of index numerical score interpretation. The index consists of six categories: 0: "None" 1: "Very low" 2: "Low" 3: "Moderate" 4: "High" 5: "Very high
`index_description`	`string` Textual explanation of current index level.
`color`	`Color` The color used to represent the Pollen Index numeric score.
`value`	`int32` The index's numeric score. Numeric range is between 0 and 5.

LookupForecastRequest

Fields
`location`	`LatLng` Required. The longitude and latitude from which the API searches for pollen forecast data.
`days`	`int32` Required. A number that indicates how many forecast days to request (minimum value 1, maximum value is 5).
`page_size`	`int32` Optional. The maximum number of daily info records to return per page. The default and max value is 5, indicating 5 days of data.
`page_token`	`string` Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token, all other request parameters provided must match the previous call that provided the page token.
`language_code`	`string` Optional. Allows the client to choose the language for the response. If data cannot be provided for that language, the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. The default value is "en".
`plants_description`	`bool` Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos. The default value is "true".

LookupForecastResponse

Fields

Fields
`region_code`	`string` The ISO_3166-1 alpha-2 code of the country/region corresponding to the location provided in the request. This field might be omitted from the response if the location provided in the request resides in a disputed territory.
`daily_info[]`	`DayInfo` Required. This object contains the daily forecast information for each day requested.
`next_page_token`	`string` Optional. The token to retrieve the next page.

region_code

string

The ISO_3166-1 alpha-2 code of the country/region corresponding to the location provided in the request. This field might be omitted from the response if the location provided in the request resides in a disputed territory.

daily_info[]

DayInfo

Required. This object contains the daily forecast information for each day requested.

next_page_token

string

Optional. The token to retrieve the next page.

DayInfo

This object contains the daily forecast information for each day requested.

Fields

Fields
`date`	`Date` The date in UTC at which the pollen forecast data is represented.
`pollen_type_info[]`	`PollenTypeInfo` This list will include up to three pollen types (GRASS, WEED, TREE) affecting the location specified in the request.
`plant_info[]`	`PlantInfo` This list will include up to 15 pollen species affecting the location specified in the request.

date

Date

The date in UTC at which the pollen forecast data is represented.

pollen_type_info[]

PollenTypeInfo

This list will include up to three pollen types (GRASS, WEED, TREE) affecting the location specified in the request.

plant_info[]

PlantInfo

This list will include up to 15 pollen species affecting the location specified in the request.

LookupHeatmapTileRequest

A heatmap tile request. The structure complies with the standard tile server GET call, i.e. https://pollen.googleapis.com/v1/mapTypes/{map_type}/heatmapTiles/{zoom}/{x}/{y}

Example: [https://pollen.googleapis.com/v1/mapTypes/TREE_UPI/heatmapTiles/0/0/0]

Fields
`map_type`	`MapType` Required. The type of the pollen heatmap. Defines the combination of pollen type and index that the map will graphically represent.
`zoom`	`int32` Required. The map's zoom level. Defines how large or small the contents of a map appear in a map view. Zoom level 0 is the entire world in a single tile. Zoom level 1 is the entire world in 4 tiles. Zoom level 2 is the entire world in 16 tiles. Zoom level 16 is the entire world in 65,536 tiles. Allowed values: 0-16
`x`	`int32` Required. Defines the east-west point in the requested tile.
`y`	`int32` Required. Defines the north-south point in the requested tile.

MapType

The type of the pollen heatmap. Defines the combination of pollen type and index that the map will graphically represent.

Enums
`MAP_TYPE_UNSPECIFIED`	Unspecified map type.
`TREE_UPI`	The heatmap type will represent a tree index graphical map.
`GRASS_UPI`	The heatmap type will represent a grass index graphical map.
`WEED_UPI`	The heatmap type will represent a weed index graphical map.

Plant

Lists available plants with varying availability across locations.

Enums
`PLANT_UNSPECIFIED`	Unspecified plant code.
`ALDER`	Alder is classified as a tree pollen type.
`ASH`	Ash is classified as a tree pollen type.
`BIRCH`	Birch is classified as a tree pollen type.
`COTTONWOOD`	Cottonwood is classified as a tree pollen type.
`ELM`	Elm is classified as a tree pollen type.
`MAPLE`	Maple is classified as a tree pollen type.
`OLIVE`	Olive is classified as a tree pollen type.
`JUNIPER`	Juniper is classified as a tree pollen type.
`OAK`	Oak is classified as a tree pollen type.
`PINE`	Pine is classified as a tree pollen type.
`CYPRESS_PINE`	Cypress pine is classified as a tree pollen type.
`HAZEL`	Hazel is classified as a tree pollen type.
`GRAMINALES`	Graminales is classified as a grass pollen type.
`RAGWEED`	Ragweed is classified as a weed pollen type.
`MUGWORT`	Mugwort is classified as a weed pollen type.

PlantDescription

Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos.

Fields
`type`	`PollenType` The plant's pollen type. For example: "GRASS". A list of all available codes could be found here.
`family`	`string` A human readable representation of the plant family name. Example: "Betulaceae (the Birch family)".
`season`	`string` Textual list of explanations of seasons where the pollen is active. Example: "Late winter, spring".
`special_colors`	`string` Textual description of the plants' colors of leaves, bark, flowers or seeds that helps identify the plant.
`special_shapes`	`string` Textual description of the plants' shapes of leaves, bark, flowers or seeds that helps identify the plant.
`cross_reaction`	`string` Textual description of pollen cross reaction plants. Example: Alder, Hazel, Hornbeam, Beech, Willow, and Oak pollen.
`picture`	`string` Link to the picture of the plant.
`picture_closeup`	`string` Link to a closeup picture of the plant.

PlantInfo

This object contains the daily information on specific plant.

Fields
`code`	`Plant` The plant code name. For example: "COTTONWOOD". A list of all available codes could be found here.
`display_name`	`string` A human readable representation of the plant name. Example: “Cottonwood".
`index_info`	`IndexInfo` This object contains data representing specific pollen index value, category and description.
`plant_description`	`PlantDescription` Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos.
`in_season`	`bool` Indication of either the plant is in season or not.

PollenType

Pollen Type Code

Enums
`POLLEN_TYPE_UNSPECIFIED`	Unspecified plant type.
`GRASS`	Grass pollen type.
`TREE`	Tree pollen type.
`WEED`	Weed pollen type.

PollenTypeInfo

This object contains the pollen type index and health recommendation information on specific pollen type.

Fields
`code`	`PollenType` The pollen type's code name. For example: "GRASS"
`display_name`	`string` A human readable representation of the pollen type name. Example: "Grass"
`index_info`	`IndexInfo` Contains the Universal Pollen Index (UPI) data for the pollen type.
`health_recommendations[]`	`string` Textual list of explanations, related to health insights based on the current pollen levels.
`in_season`	`bool` Indication whether the plant is in season or not.