Package google.maps.pollen.v1

インデックス

Pollen

Pollen API のサービス定義。

LookupForecast

rpc LookupForecast(LookupForecastRequest) returns (LookupForecastResponse)

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

認可スコープ

次の 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

インデックス数値スコアの解釈のテキスト分類。インデックスは次の 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

省略可。季節性の詳細、特別な形状や色、アレルギー性交差反応に関する情報、植物の写真など、植物に関する一般的な情報が含まれています。デフォルト値は「true」です。

LookupForecastResponse

フィールド
region_code

string

リクエストで指定された地域に対応する国/地域の ISO_3166-1 alpha-2 コード。リクエストで指定された場所が係争地にある場合は、レスポンスからこのフィールドが省略されることがあります。
daily_info[]

DayInfo

必須。このオブジェクトには、リクエストされた各日の日次予報情報が含まれます。
next_page_token

string

省略可。次のページを取得するためのトークン。

DayInfo

このオブジェクトには、リクエストされた各日の日次予報情報が含まれます。

フィールド
date

Date

花粉飛散予報データを表す日付（UTC）。
pollen_type_info[]

PollenTypeInfo

このリストには、リクエストで指定された場所に影響する花粉の種類（GRASS、WEED、TREE）が最大 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

必須。リクエストされたタイルの南北点を定義します。

マップタイプ

花粉ヒートマップのタイプ。地図でグラフィカルに表示する花粉の種類と指数の組み合わせを定義します。

列挙型
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

植物が季節を迎えているかどうかを示す。