Package google.maps.pollen.v1

索引

Pollen

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

這份清單最多會列出三種花粉類型 (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 Elm 屬於樹狀花粉類型。
MAPLE Maple 分為樹木花粉類型。
OLIVE 橄欖屬於樹花類型。
JUNIPER 刺柏屬於樹狀花粉類型。
OAK 橡樹屬於樹花類型。
PINE 松樹屬於樹花類型,
CYPRESS_PINE 柏松樹屬於樹木花粉類型。
HAZEL 霧灰色屬於樹木花粉類型。
GRAMINALES 文法類屬植物的花粉類型。
RAGWEED 豚草屬於雜草類。
MUGWORT 艾草屬於雜草類花粉類型。

PlantDescription

包含植物的一般資訊,包括植物的一般資訊、特殊形狀和顏色、過敏的交叉反應資訊和植物相片。

欄位
type

PollenType

植物的花粉類型。例如:「GRASS」。這裡列出了所有可用的代碼。

family

string

人類可讀的植物系列名稱。例如:「Betulaceae (樺樹家族)」。

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

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