索引
Pollen
(接口)Index
(枚举)IndexInfo
(消息)LookupForecastRequest
(消息)LookupForecastResponse
(消息)LookupForecastResponse.DayInfo
(消息)LookupHeatmapTileRequest
(消息)LookupHeatmapTileRequest.MapType
(枚举)Plant
(枚举)PlantDescription
(消息)PlantInfo
(消息)PollenType
(枚举)PollenTypeInfo
(消息)
花粉
Pollen API 的服务定义。
LookupForecast |
---|
每天最多可返回 5 天内的花粉量信息,涵盖超过 65 个国家/地区,分辨率最高可达 1 公里。
|
LookupHeatmapTile |
---|
返回一个字节数组,其中包含图块 PNG 图片的数据。
|
索引
索引代码
枚举 | |
---|---|
INDEX_UNSPECIFIED |
未指定索引。 |
UPI |
通用花粉指数。 |
IndexInfo
此对象包含表示特定花粉索引值、类别和说明的数据。
字段 | |
---|---|
code |
索引的代码。此字段使用蛇形命名法(而非空格)来表示出于编程目的的索引。示例:“UPI”。 |
display_name |
直观易懂的索引名称表示法。例如:“通用花粉指数”。 |
category |
索引数值得分解释的文本分类。该索引包含六个类别:
|
index_description |
当前索引级别的文本说明。 |
color |
用于表示花粉指数数字评分的颜色。 |
value |
索引的分数值。数字范围介于 0 到 5 之间。 |
LookupForecastRequest
字段 | |
---|---|
location |
必需。API 用于搜索花粉预测数据的经度和纬度。 |
days |
必需。指示要请求多少预测天数的数字(最小值 1,最大值为 5)。 |
page_size |
可选。每页返回的每日信息记录数量上限。默认值和最大值为 5(5 天的数据)。 |
page_token |
可选。从上一次每日调用收到的页面令牌。它用于检索后续页面。 请注意,在为页面令牌提供值时,提供的所有其他请求参数必须与之前提供页面令牌的调用一致。 |
language_code |
可选。允许客户端选择响应的语言。如果无法针对该语言提供数据,API 会使用最接近的匹配项。允许的值遵循 IETF BCP-47 标准。默认值为“en”。 |
plants_description |
可选。包含有关植物的一般信息,包括植物季节性的详细信息、特殊形状和颜色、有关过敏交叉反应的信息,以及植物照片。 |
LookupForecastResponse
字段 | |
---|---|
region_code |
与请求中提供的位置对应的国家/地区的 ISO_3166-1 alpha-2 代码。如果请求中提供的位置位于有争议的地区,响应中可能会省略此字段。 |
daily_info[] |
必需。此对象包含所请求的每一天的每日天气预报信息。 |
next_page_token |
可选。用于检索下一页的令牌。 |
DayInfo
此对象包含所请求的每一天的每日天气预报信息。
字段 | |
---|---|
date |
表示花粉预报数据的日期(采用世界协调时间)。 |
pollen_type_info[] |
此列表将包括(最多)三种影响请求中指定位置的花粉类型(草、杂草、树)。 |
plant_info[] |
此列表将包括(最多)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 |
必需。花粉热图的类型。定义地图将以图形方式表示的花粉类型和索引组合。 |
zoom |
必需。地图的缩放级别。定义地图内容在地图视图中显示的大小。
允许使用的值:0-16 |
x |
必需。定义所请求图块中的东-西点。 |
y |
必需。定义所请求的图块中的南北点。 |
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 |
植物的花粉类型。例如:“GRASS”。您可以在此处找到所有可用代码的列表。 |
family |
植物系列名称的人类可读表示法。例如:“桦木科”。 |
season |
对花粉处于活动状态的季节进行解释的文本列表。例如:“冬末、春季”。 |
special_colors |
植物叶子、树皮、花朵或种子颜色的文字说明,有助于识别植物。 |
special_shapes |
植物叶子、树皮、花朵或种子形状的文字说明,有助于识别植物。 |
cross_reaction |
花粉交叉反应植物的文字说明。示例:桤木、榛树、鹅耳枥、山毛榉、柳树和橡树花粉。 |
picture |
链接到植物图片。 |
picture_closeup |
链接到该植物的特写图片。 |
PlantInfo
此对象包含特定植物的每日信息。
字段 | |
---|---|
code |
植物代号。例如:“COTTONWOOD”。您可以在此处找到所有可用代码的列表。 |
display_name |
植物名称的人类可读表示法。示例:“棉白杨”。 |
index_info |
此对象包含表示特定花粉索引值、类别和说明的数据。 |
plant_description |
包含有关植物的一般信息,包括植物季节性的详细信息、特殊形状和颜色、有关过敏交叉反应的信息,以及植物照片。 |
in_season |
表明植物是否生长。 |
PollenType
花粉类型代码
枚举 | |
---|---|
POLLEN_TYPE_UNSPECIFIED |
未指定的植物类型。 |
GRASS |
草花粉类型。 |
TREE |
树木花粉类型。 |
WEED |
杂草花粉类型。 |
PollenTypeInfo
此对象包含花粉类型指数和特定花粉类型的健康建议信息。
字段 | |
---|---|
code |
花粉类型的代号。例如:“GRASS” |
display_name |
花粉类型名称的人类可读表示法。示例:“草” |
index_info |
包含花粉类型的通用花粉指数 (UPI) 数据。 |
health_recommendations[] |
与基于当前花粉水平的健康数据分析相关的文字说明列表。 |
in_season |
指示植物是否生长。 |