- בקשת HTTP
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- LatLng
- DayInfo
- Date (תאריך)
- PollenTypeInfo
- PollenType
- IndexInfo
- אינדקס
- צבע
- PlantInfo
- צמח
- PlantDescription
- רוצים לנסות?
מחזירה מידע יומי של אבקנים למשך עד 5 ימים ביותר מ-65 מדינות, ברזולוציה של עד 1 ק"מ.
בקשת HTTP
GET https://pollen.googleapis.com/v1/forecast:lookup
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
location |
חובה. קו האורך וקו הרוחב שמהם ה-API מחפש נתוני תחזיות של אבקנים. |
days |
חובה. מספר שמציין כמה ימים חזויים צריך לבקש (ערך מינימלי 1, הערך המקסימלי הוא 5). |
pageSize |
זה שינוי אופציונלי. המספר המקסימלי של רשומות מידע יומיות שצריך להחזיר בכל דף. ברירת המחדל והערך המקסימלי הם 5, שמעידים על נתונים מ-5 ימים. |
pageToken |
זה שינוי אופציונלי. אסימון דף שהתקבל משיחה יומית קודמת. הוא משמש לאחזור הדף הבא. שימו לב שכשמציינים ערך לאסימון הדף, כל הפרמטרים האחרים של הבקשה חייבים להתאים לקריאה הקודמת שסיפקה את אסימון הדף. |
languageCode |
זה שינוי אופציונלי. הלקוח יכול לבחור את השפה של התשובה. אם אי אפשר לספק נתונים עבור השפה הזו, ה-API משתמש בהתאמה הקרובה ביותר. הערכים המותרים מסתמכים על תקן IETF BCP-47. ערך ברירת המחדל הוא en. |
plantsDescription |
זה שינוי אופציונלי. מכיל מידע כללי על צמחים, כולל פרטים על העונתיות שלהם, צורות וצבעים מיוחדים, מידע על תגובות אלרגיות ותמונות צמחים. ערך ברירת המחדל הוא 'true'. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"regionCode": string,
"dailyInfo": [
{
object ( |
שדות | |
---|---|
regionCode |
קוד ISO_3166-1 alpha-2 של המדינה/האזור התואמים למיקום שצוין בבקשה. אם המיקום שצוין בבקשה נמצא באזור שנוי במחלוקת, יכול להיות שהשדה הזה יושמט מהתשובה. |
dailyInfo[] |
חובה. האובייקט הזה מכיל את פרטי התחזית היומית לכל יום מבוקש. |
nextPageToken |
זה שינוי אופציונלי. האסימון שצריך לאחזר את הדף הבא. |
היקפי ההרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/cloud-platform
למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.
LatLng
אובייקט שמייצג צמד של קו רוחב/קו אורך. הערך הזה מבוטאת כצמד של כפולים כדי לייצג מעלות קו רוחב ומעלות קו אורך. האובייקט חייב לעמוד בדרישות של תקן WGS84, אלא אם צוין אחרת. הערכים חייבים להיות בטווחים מנורמלים.
ייצוג JSON |
---|
{ "latitude": number, "longitude": number } |
שדות | |
---|---|
latitude |
קו הרוחב במעלות. הוא חייב להיות בטווח [-90.0, +90.0]. |
longitude |
קו האורך במעלות. הוא חייב להיות בטווח [-180.0, +180.0]. |
DayInfo
האובייקט הזה מכיל את פרטי התחזית היומית לכל יום מבוקש.
ייצוג JSON |
---|
{ "date": { object ( |
שדות | |
---|---|
date |
התאריך ב-UTC שבו מוצגים נתוני תחזית האבקנים. |
pollenTypeInfo[] |
הרשימה הזו תכלול עד שלושה סוגי אבקנים (GRASS , WEED ו-TREE) שמשפיעים על המיקום שצוין בבקשה. |
plantInfo[] |
הרשימה הזו תכלול עד 15 מינים של אבקנים שמשפיעים על המיקום שצוין בבקשה. |
תאריך
מייצג תאריך קלנדרי מלא או חלקי, כמו יום הולדת. השעה ביום ואזור הזמן מצוינים במקום אחר או לא משמעותיים. התאריך הוא ביחס ללוח השנה הגרגוריאני. המצב הזה יכול לייצג אחת מהאפשרויות הבאות:
- תאריך מלא, עם ערכים שונים של שנה, חודש ויום.
- חודש ויום, עם שנה אפס (למשל יום נישואין).
- שנה בפני עצמה, עם חודש אפס ויום אפס.
- שנה וחודש, עם יום אפס (לדוגמה, תאריך תפוגה של כרטיס אשראי).
סוגים קשורים:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
ייצוג JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
שדות | |
---|---|
year |
השנה שבה חל התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה. |
month |
החודש בשנה. הערך חייב להיות 1 עד 12, או 0 כדי לציין שנה בלי חודש ויום. |
day |
היום בחודש. הערך צריך להיות בין 1 ל-31 ותקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם אין חשיבות לציון יום מסוים. |
PollenTypeInfo
האובייקט הזה מכיל את האינדקס של סוג האבקנים ומידע על המלצות הבריאות לגבי סוג אבקנים ספציפי.
ייצוג JSON |
---|
{ "code": enum ( |
שדות | |
---|---|
code |
שם הקוד של סוג האבקנים. לדוגמה: "GRASS" |
displayName |
ייצוג קריא לאנשים של שם סוג האבקנים. דוגמה: "דשא" |
indexInfo |
מכיל את נתונים של מדד האבקנים האוניברסלי (UPI) לסוג האבקנים. |
healthRecommendations[] |
רשימה טקסטית של הסברים שקשורים לתובנות בריאותיות על סמך רמות האבקנים הנוכחיות. |
inSeason |
ציון אם הצמח בעונה או לא. |
PollenType
קוד סוג האבקנים
טיפוסים בני מנייה (enum) | |
---|---|
POLLEN_TYPE_UNSPECIFIED |
סוג הצמח לא צוין. |
GRASS |
סוג אבקני העשבים. |
TREE |
סוג אבקני העצים. |
WEED |
סוג אבקני עשב. |
IndexInfo
האובייקט הזה מכיל נתונים שמייצגים ערך, קטגוריה ותיאור ספציפיים של מדד האבקנים.
ייצוג JSON |
---|
{ "code": enum ( |
שדות | |
---|---|
code |
בקוד של האינדקס. השדה הזה מייצג את האינדקס למטרות תכנות על ידי שימוש בתרחישים של נחשים במקום ברווחים. דוגמה: UPI. |
displayName |
ייצוג קריא (לבני אדם) של שם האינדקס. דוגמה: "אינדקס אבקנים אוניברסלי". |
category |
סיווג הטקסט של פירוש הציון המספרי של האינדקס. האינדקס מורכב משש קטגוריות:
|
indexDescription |
הסבר טקסטואלי של רמת האינדקס הנוכחית. |
color |
הצבע המשמש לייצוג הציון המספרי של מדד האבקנים. |
value |
הציון המספרי של האינדקס. הטווח המספרי הוא בין 0 ל-5. |
אינדקס
קוד אינדקס
טיפוסים בני מנייה (enum) | |
---|---|
INDEX_UNSPECIFIED |
אינדקס לא צוין. |
UPI |
מדד אבקנים אוניברסלי. |
צבע
מייצג צבע במרחב הצבעים RGBA. הייצוג הזה נועד לאפשר פשטות המרה אל ומתוך ייצוגי צבע בשפות שונות, על-פני קומפקטיות. לדוגמה, אפשר לספק את השדות של הייצוג הזה באופן טריוויאלי ל-constructor של java.awt.Color
ב-Java; אפשר גם לספק אותו באופן טריוויאלי ל-method +colorWithRed:green:blue:alpha
של UIColor ב-iOS. ובמאמץ קטן, ניתן לעצב אותו בקלות למחרוזת rgba()
CSS ב-JavaScript.
בדף העזר הזה אין מידע על מרחב הצבעים המוחלט שצריך להשתמש בו כדי לפרש את ערך ה-RGB – לדוגמה, sRGB, Adobe RGB, DCI-P3 ו-BT.2020. כברירת מחדל, האפליקציות צריכות להשתמש במרחב הצבעים sRGB.
אם צריך לקבוע שיוויון צבעים, אם לא תועד אחרת, המערכת תתייחס לשני צבעים באופן שווה אם כל הערכים בצבע אדום, ירוק, כחול ואלפא שונים זה מזה ב-1e-5
לכל היותר.
דוגמה (Java):
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor) {
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
}
public static Color toProto(java.awt.Color color) {
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255) {
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
}
return resultBuilder.build();
}
// ...
דוגמה (iOS / Obj-C):
// ...
static UIColor* fromProto(Color* protocolor) {
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil) {
alpha = [alpha_wrapper value];
}
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
}
static Color* toProto(UIColor* color) {
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
return nil;
}
Color* result = [[Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999) {
[result setAlpha:floatWrapperWithValue(alpha)];
}
[result autorelease];
return result;
}
// ...
דוגמה (JavaScript):
// ...
var protoToCssColor = function(rgb_color) {
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color)) {
return rgbToCssColor(red, green, blue);
}
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};
var rgbToCssColor = function(red, green, blue) {
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++) {
resultBuilder.push('0');
}
resultBuilder.push(hexString);
return resultBuilder.join('');
};
// ...
ייצוג JSON |
---|
{ "red": number, "green": number, "blue": number, "alpha": number } |
שדות | |
---|---|
red |
כמות הצבע האדום כערך במרווחים [0, 1]. |
green |
כמות הצבע הירוק כערך במרווחים [0, 1]. |
blue |
כמות הצבע הכחול כערך במרווח הזמן [0, 1]. |
alpha |
החלק של הצבע הזה שיש להחיל על הפיקסל. כלומר, צבע הפיקסל הסופי מוגדר באמצעות המשוואה:
המשמעות היא שהערך של 1.0 תואם לצבע מלא, ואילו ערך של 0.0 מייצג צבע שקוף לחלוטין. הפעולה הזו משתמשת בהודעת wrapper במקום בסקלר צף פשוט כדי שאפשר יהיה להבחין בין ערך ברירת מחדל לערך שאינו מוגדר. אם לא מציינים את הפרמטר הזה, האובייקט של הצבע מוצג כצבע אחיד (כאילו צוין ערך אלפא שניתן באופן מפורש לערך 1.0). |
PlantInfo
האובייקט הזה מכיל את המידע היומי על צמח ספציפי.
ייצוג JSON |
---|
{ "code": enum ( |
שדות | |
---|---|
code |
שם הקוד של הצמח. לדוגמה: "COTTONWOOD". כאן ניתן למצוא רשימה של כל הקודים הזמינים. |
displayName |
ייצוג קריא (לבני אדם) של שם הצמח. דוגמה: "צפצפה". |
indexInfo |
האובייקט הזה מכיל נתונים שמייצגים ערך, קטגוריה ותיאור ספציפיים של מדד האבקנים. |
plantDescription |
מכיל מידע כללי על צמחים, כולל פרטים על העונתיות שלהם, צורות וצבעים מיוחדים, מידע על תגובות אלרגיות ותמונות צמחים. |
inSeason |
אינדיקציה לכך שהצמח הוא בעונה או לא. |
צמח
הצגת רשימה של צמחים זמינים עם זמינות שונה במיקומים שונים.
טיפוסים בני מנייה (enum) | |
---|---|
PLANT_UNSPECIFIED |
קוד הצמח לא צוין. |
ALDER |
אלמון מסווג כסוג אבקני עצים. |
ASH |
האפר מסווג כסוג של אבקני עצים. |
BIRCH |
שדר מסווג כסוג אבקני עץ. |
COTTONWOOD |
צפצפה מסווגת כסוג של אבקני עצים. |
ELM |
בוקיצה מסווגת כסוג של אבקני עצים. |
MAPLE |
אֶדֶר מסווג כסוג אבקני עץ. |
OLIVE |
זית מסווג כסוג אבקני עץ. |
JUNIPER |
ערער מסווג כסוג אבקני עץ. |
OAK |
אלון מסווג בתור סוג של אבקני עצים. |
PINE |
אורן מסווג בתור סוג של אבקני עצים. |
CYPRESS_PINE |
אורן ברוש מסווג כסוג של אבקני עצים. |
HAZEL |
אלסר מסווגת כסוג של אבקני עצים. |
GRAMINALES |
דגניים מסווגים כסוג של אבקני עשב. |
RAGWEED |
אמברוסיה מסווגת כסוג של אבקני עשב. |
MUGWORT |
לענה מסווגת כסוג אבקני עשב. |
PlantDescription
מכיל מידע כללי על צמחים, כולל פרטים על העונתיות שלהם, צורות וצבעים מיוחדים, מידע על תגובות אלרגיות ותמונות צמחים.
ייצוג JSON |
---|
{
"type": enum ( |
שדות | |
---|---|
type |
סוג האבקנים של הצמח. לדוגמה: "GRASS". כאן ניתן למצוא רשימה של כל הקודים הזמינים. |
family |
ייצוג קריא (לבני אדם) של שם משפחת הצמחים. דוגמה: "שדרות מקסיקניות". |
season |
רשימה טקסטית של הסברים על העונות שבהן האבקנים פעילים. דוגמה: "סוף החורף, אביב". |
specialColors |
תיאור טקסטואלי של הצמחים צבעים של עלים, קליפת עץ, פרחים או זרעים שעוזרים לזהות את הצמח. |
specialShapes |
תיאור טקסטואלי של הצמחים צורות של עלים, קליפת עץ, פרחים או זרעים שעוזרים לזהות את הצמח. |
crossReaction |
תיאור טקסטי של צמחי תגובה לאבקנים. דוגמה: אבקני אלמון, אלסר, אלה לבנה, אשור, ערבה ואלון. |
picture |
קישור לתמונה של הצמח. |
pictureCloseup |
קישור לתמונת תקריב של הצמח. |