Package google.maps.pollen.v1

索引

Pollen

Pollen API のサービス定義。

LookupForecast

rpc LookupForecast(LookupForecastRequest) returns (LookupForecastResponse)

65 か国以上における毎日最大 5 日間の花粉情報を返します。最大解像度 1 km。

認可スコープ

次の 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 Universal Pollen Index(世界の花粉飛散量指数)。

IndexInfo

このオブジェクトには、特定の花粉飛散量指数値、カテゴリ、説明を表すデータが含まれています。

フィールド
code

Index

インデックスのコード。このフィールドは、プログラミング目的のインデックスを表すため、スペースの代わりにスネークケースを使用します。例: 「UPI」。

display_name

string

人が読める形式のインデックス名。例: 「ユニバーサル花粉指数」。

category

string

インデックスの数値スコア解釈のテキスト分類。このインデックスは 6 つのカテゴリで構成されています。

  • 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

花粉飛散量予報データが表示される日付(UTC)。

pollen_type_info[]

PollenTypeInfo

このリストには、リクエストで指定された場所に影響する花粉のタイプ(草、雑草、樹木)が(最大 3 つ)含まれます。

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 つのタイルに表示されます。
  • ズームレベル 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

植物名を人間が判読できる形式で表したもの。例: 「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

植物が繁殖期にあるかどうか。