Package google.maps.pollen.v1

אינדקס

אבקנים

הגדרת שירות ל-Polen API.

LookupForecast

rpc LookupForecast(LookupForecastRequest) returns (LookupForecastResponse)

הפונקציה מחזירה מידע יומי על אבקנים של עד 5 ימים ביותר מ-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.

אינדקס

קוד אינדקס

טיפוסים בני מנייה (enums)
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

התאריך ב-UTC שבו מוצגים נתוני תחזית האבקנים.
pollen_type_info[]

PollenTypeInfo

הרשימה תכלול (עד) שלושה סוגי אבקנים (דשא, עשב, עץ) שמשפיעים על המיקום שצוין בבקשה.
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

הסוג של מפת החום של אבקנים. מגדיר את השילוב של סוג האבקנים והאינדקס שהמפה תייצג באופן גרפי.

טיפוסים בני מנייה (enums)
MAP_TYPE_UNSPECIFIED סוג המפה לא צוין.
TREE_UPI הסוג 'מפת חום' ייצג מפה גרפית של אינדקס עץ.
GRASS_UPI הסוג 'מפת חום' ייצג מפה גרפית של אינדקס דשא.
WEED_UPI סוג מפת החום ייצג מפה גרפית של אינדקס עשב.

צמח

רשימת הצמחים הזמינים עם זמינות שונה במיקומים שונים.

טיפוסים בני מנייה (enums)
PLANT_UNSPECIFIED קוד הצמח לא צוין.
ALDER אלמון מסווג כסוג של אבקני עצים.
ASH אפר מסווג כסוג של אבקנים של עצים.
BIRCH ליבנה מסווג כסוג אבקנים של עצים.
COTTONWOOD עצי הצפצפה מסווגת כסוג האבקנים של העץ.
ELM בוקיצה מסווגת כסוג של אבקני עץ.
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

קוד של סוג אבקנים

טיפוסים בני מנייה (enums)
POLLEN_TYPE_UNSPECIFIED סוג הצמח לא צוין.
GRASS סוג של אבקנים של עשבים.
TREE סוג האבקנים של העצים.
WEED סוג של אבקני עשבים.

PollenTypeInfo

האובייקט הזה מכיל את האינדקס של סוג האבקנים ומידע על המלצות לבריאות לגבי סוג מסוים של אבקנים.

שדות
code

PollenType

שם הקוד של סוג האבקנים. לדוגמה: "GRASS"
display_name

string

ייצוג קריא לאנשים של שם סוג האבקנים. דוגמה: "דשא"
index_info

IndexInfo

מכיל את הנתונים של מדד האבקנים האוניברסלי (UPI) לסוג האבקנים.
health_recommendations[]

string

רשימת הסברים טקסטואליים, שקשורים לתובנות בנושאי בריאות על סמך רמות האבקנים הנוכחיות.
in_season

bool

אינדיקציה אם הצמח בעונה או לא.