Package google.maps.pollen.v1

索引

Pollen

Pollen API 的服務定義。

LookupForecast

rpc LookupForecast(LookupForecastRequest) returns (LookupForecastResponse)

最多可傳回 65 個國家/地區的每日花粉資訊，最多可傳回 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

選用設定。包含植物的一般資訊，包括植物的季節性細節、特殊形狀和色彩、過敏反應以及植物相片等資訊。

LookupForecastResponse

欄位
region_code

string

與要求中提供的地點相應的國家/地區 ISO_3166-1 alpha-2 代碼。如果要求中提供的位置位於爭議地區，回應中可能會略過這個欄位。
daily_info[]

DayInfo

必要欄位。這個物件包含每天要求的每日預測資訊。
next_page_token

string

選用設定。用來擷取下一頁的權杖。

DayInfo

這個物件包含每天要求的每日預測資訊。

欄位
date

Date

呈現花粉預測資料的日期 (以世界標準時間為準)。
pollen_type_info[]

PollenTypeInfo

這份清單包含 (最多) 三種花粉類型 (草、草、樹)，影響要求中指定的位置。
plant_info[]

PlantInfo

這份清單將包括 (最多) 15 個花粉品種，影響要求中指定的地點。

LookupHeatmapTileRequest

熱視圖圖塊要求。結構符合標準圖塊伺服器 GET 呼叫，也就是https://pollen.googleapis.com/v1/mapTypes/{map_type}/heatmapTiles/{zoom}/{x}/{y}

例如：[https://polen.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

花粉交叉反應植物的文字說明。例：Alder、霧灰色、角樹、山毛櫸、柳樹和橡樹花粉。
picture

string

植物圖片的連結。
picture_closeup

string

植物特寫圖片的連結。

PlantInfo

這個物件包含特定植物的每日資訊。

欄位
code

Plant

植物代碼名稱。例如「COTTONWOOD」。所有可用代碼的清單列於此處。
display_name

string

植物名稱的清楚易讀表示法。例如：「Cottonwood」
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

表示植物是否屬於季節值。