Package google.maps.pollen.v1

索引

花粉

Pollen API 服务定义。

LookupForecast

rpc LookupForecast(LookupForecastRequest) returns (LookupForecastResponse)

可返回超过 65 个国家/地区每天 5 天的花粉信息，分辨率最高可达 1 公里。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅 OAuth 2.0 概览。
LookupHeatmapTile

rpc LookupHeatmapTile(LookupHeatmapTileRequest) returns (HttpBody)

返回一个字节数组，其中包含图块 PNG 图片的数据。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅 OAuth 2.0 概览。

索引

索引代码

枚举
INDEX_UNSPECIFIED 未指定索引。
UPI 通用花粉指数。

IndexInfo

此对象包含表示特定花粉指数值、类别和说明的数据。

字段
code

Index

索引的代码。此字段表示用于编程目的的索引（使用蛇形命名法而不是空格）。例如：“UPI”。
display_name

string

直观易懂的索引名称表示法。例如：“通用花粉指数”。
category

string

索引数字得分解释的文本分类。该索引包含六个类别：

  • 0：“无”
  • 1：“非常低”
  • 2：“不理想”
  • 3：“中等”
  • 4：“高”
  • 5：“非常高
index_description

string

当前索引级别的文字说明。
color

Color

用于表示花粉指数数字得分的颜色。
value

int32

索引的分值。数字范围在 0 到 5 之间。

LookupForecastRequest

字段
location

LatLng

必需。API 搜索花粉预测数据的经度和纬度。
days

int32

必需。一个数字，表示需要请求的预测天数（最小值为 1，最大值为 5）。
page_size

int32

可选。每页返回的每日信息记录数量上限。默认值和最大值均为 5，表示 5 天的数据。
page_token

string

可选。从上一次每日调用收到的页面令牌。它用于检索后续页面。

请注意，为页面令牌提供值时，提供的所有其他请求参数必须与先前提供页面令牌的调用一致。
language_code

string

可选。允许客户端选择响应的语言。如果无法为该语言提供数据，API 会使用最接近的匹配项。允许的值遵循 IETF BCP-47 标准。默认值为“en”。
plants_description

bool

可选。包含有关植物的一般信息，包括其季节性变化、特殊形状和颜色的详细信息、有关过敏交叉反应的信息以及植物照片。默认值为“true”。

LookupForecastResponse

字段
region_code

string

与请求中提供的位置相对应的国家/地区的 ISO_3166-1 alpha-2 代码。如果要求中提供的地点位于有争议的地区，响应中可能会省略此字段。
daily_info[]

DayInfo

必需。此对象包含所请求的每一天的每日天气预报信息。
next_page_token

string

可选。用于检索下一页的令牌。

DayInfo

此对象包含所请求的每一天的每日天气预报信息。

字段
date

Date

表示花粉预测数据的日期（采用世界协调时间）。
pollen_type_info[]

PollenTypeInfo

此列表将包含最多 3 种会影响请求中指定的位置的花粉类型（GRASS、WEED、TREE）。
plant_info[]

PlantInfo

此列表最多将包含影响要求中指定的位置的花粉种类（最多 15 个）。

LookupHeatmapTileRequest

热图图块请求。该结构符合标准的图块服务器 GET 调用，即 https://pollen.googleapis.com/v1/mapTypes/{map_type}/heatmapTiles/{zoom}/{x}/{y}

示例：[https://pollen.googleapis.com/v1/mapTypes/TREE_UPI/heatmapTiles/0/0/0]

字段
map_type

MapType

必需。花粉热图的类型。定义地图将以图形方式表示的花粉类型和索引的组合。
zoom

int32

必需。地图的缩放级别。定义地图内容在地图视图中的显示大小。

  • 缩放级别 0 是单个图块中显示的整个世界。
  • 缩放级别 1 显示整个世界由 4 个图块构成。
  • 缩放级别 2 则由 16 个图块构成。
  • 缩放级别 16 包含 65,536 个图块，代表整个世界。

允许的值：0-16
x

int32

必需。定义所请求的图块中的东西点。
y

int32

必需。定义所请求的图块中的南北点。

MapType

花粉热图的类型。定义地图将以图形方式表示的花粉类型和索引的组合。

枚举
MAP_TYPE_UNSPECIFIED 未指定的地图类型。
TREE_UPI 热图类型将表示树索引图形地图。
GRASS_UPI 热图类型将表示草地索引图形地图。
WEED_UPI 热图类型将表示杂草索引图形地图。

植物

列出各地点供应情况不同的可用植物。

枚举
PLANT_UNSPECIFIED 未指定的植物代码。
ALDER 桤木属于树类花粉类型。
ASH 白蜡树属于树类花粉类型。
BIRCH 桦树是一种树花粉类型。
COTTONWOOD 棉白杨属于树类花粉类型。
ELM 榆树属于树类花粉类型。
MAPLE 枫树属于树类花粉类型。
OLIVE 橄榄属于树类花粉类型。
JUNIPER 杜松属于树木花粉类型。
OAK 橡树属于树花粉类型。
PINE 松树属于树花粉类型。
CYPRESS_PINE 柏松属于树类花粉类型。
HAZEL 榛树属于树类花粉类型。
GRAMINALES 草本植物属于草类花粉类型。
RAGWEED 豚草属于杂草花粉类型。
MUGWORT 艾蒿属于杂草花粉类型。

PlantDescription

包含有关植物的一般信息，包括其季节性变化、特殊形状和颜色的详细信息、有关过敏交叉反应的信息以及植物照片。

字段
type

PollenType

植物的花粉类型。例如：“GRASS”。您可以在此处找到所有可用代码的列表。
family

string

以人类可读的方式表示的植物系列名称。示例：“白杨木科（桦树科）”。
season

string

对有花粉的季节的说明文字列表。例如：“冬末、春季”。
special_colors

string

植物的文字说明叶子、树皮、花朵或种子的颜色，有助于识别植物。
special_shapes

string

植物的文字说明叶子、树皮、花朵或种子的形状，以帮助识别植物。
cross_reaction

string

花粉交叉反应植物的文字说明。示例：桤木、榛树、鹅耳枥、山毛榉、柳树和橡树花粉。
picture

string

指向植物图片的链接。
picture_closeup

string

指向植物特写照片的链接。

PlantInfo

此对象包含特定植物的每日信息。

字段
code

Plant

植物代号。例如：“COTTONWOOD”。您可以在此处找到所有可用代码的列表。
display_name

string

人类可读的植物名称表示形式。示例：“棉白木”。
index_info

IndexInfo

此对象包含表示特定花粉指数值、类别和说明的数据。
plant_description

PlantDescription

包含有关植物的一般信息，包括其季节性变化、特殊形状和颜色的详细信息、有关过敏交叉反应的信息以及植物照片。
in_season

bool

表明植物是否生长。

PollenType

花粉类型代码

枚举
POLLEN_TYPE_UNSPECIFIED 未指定的植物类型。
GRASS 草花粉类型。
TREE 树花粉类型。
WEED 杂草花粉类型。

PollenTypeInfo

此对象包含特定花粉类型的花粉类型索引和健康建议信息。

字段
code

PollenType

花粉类型的代号。例如：“GRASS”
display_name

string

花粉类型名称的人类可读表示法。示例：“草”
index_info

IndexInfo

包含花粉类型的通用花粉指数 (UPI) 数据。
health_recommendations[]

string

与基于当前花粉含量的健康数据分析相关的说明文本列表。
in_season

bool

指示植物是否季节。