Method: forecast.lookup

แสดงผลข้อมูลเกสรดอกไม้รายวันสูงสุด 5 วันในกว่า 65 ประเทศ และความละเอียดสูงสุด 1 กม.

คำขอ HTTP

GET https://pollen.googleapis.com/v1/forecast:lookup

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
location

object (LatLng)

ต้องระบุ ลองจิจูดและละติจูดที่ API ค้นหาข้อมูลการคาดการณ์ละอองเกสร

days

integer

ต้องระบุ ตัวเลขที่ระบุจำนวนวันการคาดการณ์ที่จะขอ (ค่าต่ำสุด 1 ค่าสูงสุดคือ 5)

pageSize

integer

ไม่บังคับ จำนวนสูงสุดของบันทึกข้อมูลรายวันที่จะแสดงต่อ 1 หน้า ค่าเริ่มต้นคือ 5 (ข้อมูล 5 วัน)

pageToken

string

ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการโทรรายวันครั้งก่อน ซึ่งจะใช้เรียกหน้าถัดไป

โปรดทราบว่าเมื่อระบุค่าสำหรับโทเค็นหน้าเว็บ พารามิเตอร์คำขออื่นๆ ทั้งหมดที่ระบุต้องตรงกับการเรียกก่อนหน้าที่ระบุโทเค็นของหน้าเว็บ

languageCode

string

ไม่บังคับ อนุญาตให้ไคลเอ็นต์เลือกภาษาสำหรับคำตอบ หากไม่สามารถระบุข้อมูลสำหรับภาษานั้นได้ API จะใช้รายการที่ตรงกันที่ใกล้เคียงที่สุด ค่าที่อนุญาตขึ้นอยู่กับมาตรฐาน IETF BCP-47 ค่าเริ่มต้นคือ "en"

plantsDescription

boolean

ไม่บังคับ มีข้อมูลทั่วไปเกี่ยวกับพืช ได้แก่ รายละเอียดเกี่ยวกับฤดูกาล รูปทรงและสีพิเศษ ข้อมูลเกี่ยวกับปฏิกิริยาภูมิแพ้ข้ามได้ และรูปภาพพืช

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON
{
  "regionCode": string,
  "dailyInfo": [
    {
      object (DayInfo)
    }
  ],
  "nextPageToken": string
}
ช่อง
regionCode

string

รหัส ISO_3166-1 alpha-2 ของประเทศ/ภูมิภาคที่เกี่ยวข้องกับสถานที่ตั้งที่ระบุไว้ในคําขอ ช่องนี้อาจไม่แสดงอยู่ในการตอบกลับหากสถานที่ที่ระบุในคำขออยู่ในเขตแดนที่มีข้อขัดแย้ง

dailyInfo[]

object (DayInfo)

ต้องระบุ ออบเจ็กต์นี้มีข้อมูลการคาดการณ์รายวันสำหรับคำขอในแต่ละวัน

nextPageToken

string

ไม่บังคับ โทเค็นสำหรับเรียกดูหน้าถัดไป

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

LatLng

วัตถุที่แสดงคู่ละติจูด/ลองจิจูด ค่านี้แสดงเป็นเลขคู่ 1 คู่เพื่อแสดงองศาละติจูดและลองจิจูดองศา ออบเจ็กต์นี้ต้องเป็นไปตาม มาตรฐาน WGS84 เว้นแต่จะระบุไว้เป็นอย่างอื่น ค่าต้องอยู่ในช่วงมาตรฐาน

การแสดง JSON
{
  "latitude": number,
  "longitude": number
}
ช่อง
latitude

number

ละติจูด หน่วยเป็นองศา โดยต้องอยู่ในช่วง [-90.0, +90.0]

longitude

number

ลองจิจูด หน่วยเป็นองศา โดยต้องอยู่ในช่วง [-180.0, +180.0]

DayInfo

ออบเจ็กต์นี้มีข้อมูลการคาดการณ์รายวันสำหรับคำขอในแต่ละวัน

การแสดง JSON
{
  "date": {
    object (Date)
  },
  "pollenTypeInfo": [
    {
      object (PollenTypeInfo)
    }
  ],
  "plantInfo": [
    {
      object (PlantInfo)
    }
  ]
}
ช่อง
date

object (Date)

วันที่ในเขตเวลา UTC ที่แสดงข้อมูลการคาดการณ์เกสรดอกไม้

pollenTypeInfo[]

object (PollenTypeInfo)

รายการนี้จะมีละอองเกสร 3 ประเภท (สูงสุด) 3 ประเภท (หญ้า วัชพืช ต้นไม้) ซึ่งส่งผลต่อสถานที่ที่ระบุไว้ในคำขอ

plantInfo[]

object (PlantInfo)

รายการนี้จะมีละอองเกสรดอกไม้ (สูงสุด) 15 ชนิดที่ส่งผลต่อสถานที่ที่ระบุในคำขอ

วันที่

แสดงวันที่ในปฏิทินทั้งหมดหรือบางส่วน เช่น วันเกิด มีการระบุเวลาของวันและเขตเวลาไว้ที่อื่นหรือไม่มีนัยสำคัญ วันที่จะสัมพันธ์กับปฏิทินเกรกอเรียน ซึ่งอาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้

  • วันที่แบบเต็มพร้อมค่าปี เดือน และวันที่ไม่ใช่ 0
  • เดือนและวัน 1 ปี (เช่น วันครบรอบ)
  • 1 ปีเท่านั้น โดยมี 0 เดือนกับ 0 วัน
  • ปีและเดือนที่มี 0 วัน (เช่น วันที่หมดอายุของบัตรเครดิต)

ประเภทที่เกี่ยวข้อง

การแสดง JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
ช่อง
year

integer

ปีของวันที่ ต้องอยู่ระหว่าง 1 ถึง 9999 หรือ 0 เพื่อระบุวันที่โดยไม่ต้องใส่ปี

month

integer

เดือนของปี ค่านี้ต้องอยู่ระหว่าง 1 ถึง 12 หรือ 0 เพื่อระบุปีโดยไม่มีเดือนและวัน

day

integer

วันของเดือน ค่านี้ต้องอยู่ระหว่าง 1 ถึง 31 และใช้ได้กับปีและเดือน หรือ 0 เพื่อระบุปีอย่างเดียว หรือปีและเดือนที่วันไม่สำคัญ

PollenTypeInfo

ออบเจ็กต์นี้มีดัชนีประเภทเกสรดอกไม้และข้อมูลคำแนะนำด้านสุขภาพเกี่ยวกับเกสรดอกไม้ที่เฉพาะเจาะจง

การแสดง JSON
{
  "code": enum (PollenType),
  "displayName": string,
  "indexInfo": {
    object (IndexInfo)
  },
  "healthRecommendations": [
    string
  ],
  "inSeason": boolean
}
ช่อง
code

enum (PollenType)

ชื่อรหัสของประเภทเกสรดอกไม้ ตัวอย่างเช่น "GRASS"

displayName

string

การแสดงชื่อเกสรดอกไม้ที่มนุษย์อ่านได้ ตัวอย่าง: "หญ้า"

indexInfo

object (IndexInfo)

มีข้อมูลดัชนีเกสรดอกไม้สากล (UPI) สำหรับประเภทเกสรดอกไม้

healthRecommendations[]

string

รายการข้อความอธิบายที่เกี่ยวข้องกับข้อมูลเชิงลึกด้านสุขภาพโดยอิงตามระดับละอองเกสรในปัจจุบัน

inSeason

boolean

การระบุว่าพืชอยู่ในฤดูกาลหรือไม่

PollenType

รหัสประเภทเกสรดอกไม้

Enum
POLLEN_TYPE_UNSPECIFIED ชนิดพืชที่ไม่ได้ระบุ
GRASS ประเภทละอองเกสรหญ้า
TREE ประเภทของเกสรจากต้นไม้
WEED ประเภทเกสรจากวัชพืช

IndexInfo

ออบเจ็กต์นี้มีข้อมูลที่แทนค่าดัชนีเกสรดอกไม้ หมวดหมู่ และคำอธิบายที่เจาะจง

การแสดง JSON
{
  "code": enum (Index),
  "displayName": string,
  "category": string,
  "indexDescription": string,
  "color": {
    object (Color)
  },
  "value": integer
}
ช่อง
code

enum (Index)

โค้ดของดัชนี ช่องนี้แสดงดัชนีสำหรับวัตถุประสงค์ในการเขียนโปรแกรมโดยใช้รูปแบบงูแทนการเว้นวรรค เช่น "UPI"

displayName

string

การแสดงชื่อดัชนีที่มนุษย์อ่านได้ เช่น "ดัชนีเกสรดอกไม้สากล"

category

string

การจัดประเภทข้อความของการตีความคะแนนตัวเลขดัชนี ดัชนีประกอบด้วย 6 หมวดหมู่ ดังนี้

  • 0: "ไม่มี"
  • 1: "ต่ำมาก"
  • 2: "ต่ำ"
  • 3: "ปานกลาง"
  • 4: "สูง"
  • 5: "สูงมาก
indexDescription

string

คำอธิบายแบบข้อความของระดับดัชนีปัจจุบัน

color

object (Color)

สีที่ใช้แสดงคะแนนตัวเลขดัชนีเกสรดอกไม้

value

integer

คะแนนที่เป็นตัวเลขของดัชนี ช่วงตัวเลขอยู่ระหว่าง 0 ถึง 5

ดัชนี

รหัสดัชนี

Enum
INDEX_UNSPECIFIED ดัชนีที่ไม่ได้ระบุ
UPI ดัชนีเกสรดอกไม้สากล

สี

แสดงสีในพื้นที่สี RGBA การนำเสนอนี้ออกแบบมาเพื่อความเรียบง่ายในการแปลงไปเป็นและเปลี่ยนจากการแสดงสีในภาษาต่างๆ มากกว่าความกะทัดรัด ตัวอย่างเช่น ช่องของการนำเสนอนี้สามารถใส่ลงในตัวสร้างของ java.awt.Color ใน Java ได้ ช่องเหล่านี้ยังสามารถใส่ลงในเมธอด +colorWithRed:green:blue:alpha ของ UIColor ใน iOS ได้เพียงเล็กน้อย และสามารถจัดรูปแบบให้เป็นสตริง CSS rgba() ใน JavaScript ได้โดยง่าย ด้วยการทำงานเพียงเล็กน้อย

หน้าอ้างอิงนี้ไม่มีข้อมูลเกี่ยวกับพื้นที่สีสัมบูรณ์ที่ควรใช้เพื่อตีความค่า RGB เช่น sRGB, Adobe RGB, DCI-P3 และ BT.2020 โดยค่าเริ่มต้น แอปพลิเคชันควรใช้พื้นที่สี sRGB

เมื่อต้องตัดสินใจเรื่องความเท่าเทียมของสี การติดตั้งใช้งานจะถือว่า 2 สีเท่ากันหากค่าสีแดง เขียว น้ำเงิน และอัลฟ่าทั้งหมดแตกต่างกันไม่เกิน 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

number

จํานวนสีแดงในสีเป็นค่าในช่วง [0, 1]

green

number

ปริมาณสีเขียวในสีเป็นค่าในช่วง [0, 1]

blue

number

จํานวนสีน้ำเงินในสีเป็นค่าในช่วง [0, 1]

alpha

number

ส่วนของสีนี้ที่ควรนำไปใช้กับพิกเซล นั่นคือ สีพิกเซลสุดท้ายจะกำหนดด้วยสมการต่อไปนี้

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

หมายความว่าค่า 1.0 หมายถึงสีทึบ ขณะที่ค่า 0.0 หมายถึงสีที่โปร่งใสทั้งหมด การดำเนินการนี้จะใช้ข้อความ Wrapper แทนสเกลาร์ลอยตัวแบบง่ายเพื่อให้แยกความแตกต่างระหว่างค่าเริ่มต้นและค่าที่ยังไม่ได้ตั้งค่าได้ หากไม่ระบุ วัตถุสีนี้จะแสดงเป็นสีทึบ (เสมือนว่าค่าอัลฟ่าได้รับการกำหนดไว้อย่างชัดแจ้งเป็น 1.0)

PlantInfo

วัตถุนี้มีข้อมูลรายวันเกี่ยวกับพืชที่เฉพาะเจาะจง

การแสดง JSON
{
  "code": enum (Plant),
  "displayName": string,
  "indexInfo": {
    object (IndexInfo)
  },
  "plantDescription": {
    object (PlantDescription)
  },
  "inSeason": boolean
}
ช่อง
code

enum (Plant)

ชื่อรหัสพืช เช่น "COTTONWOOD" ดูรายการรหัสที่ใช้ได้ทั้งหมดที่นี่

displayName

string

การแสดงชื่อพืชที่มนุษย์อ่านได้ เช่น "Cottonwood"

indexInfo

object (IndexInfo)

ออบเจ็กต์นี้มีข้อมูลที่แทนค่าดัชนีเกสรดอกไม้ หมวดหมู่ และคำอธิบายที่เจาะจง

plantDescription

object (PlantDescription)

มีข้อมูลทั่วไปเกี่ยวกับพืช ได้แก่ รายละเอียดเกี่ยวกับฤดูกาล รูปทรงและสีพิเศษ ข้อมูลเกี่ยวกับปฏิกิริยาภูมิแพ้ข้ามได้ และรูปภาพพืช

inSeason

boolean

การระบุว่าพืชอยู่ในฤดูกาลหรือไม่

ต้นไม้

แสดงรายชื่อพืชที่พร้อมจำหน่ายและแตกต่างกันไปตามพื้นที่ต่างๆ

Enum
PLANT_UNSPECIFIED ไม่ได้ระบุรหัสพืช
ALDER ต้นเอลเดอร์จัดอยู่ในประเภทเกสรจากต้นไม้
ASH เถ้าจัดเป็นประเภทเกสรจากต้นไม้
BIRCH เบิร์ชจัดอยู่ในประเภทเกสรจากต้นไม้
COTTONWOOD คอตตอนวู้ดจัดอยู่ในประเภทเกสรจากต้นไม้
ELM เอล์มจัดเป็นประเภทเกสรจากต้นไม้
MAPLE เมเปิลจัดว่าเป็นเกสรจากต้นไม้ชนิดหนึ่ง
OLIVE มะกอกจัดอยู่ในประเภทเกสรจากต้นไม้
JUNIPER จูนิเปอร์จัดว่าเป็นเกสรจากต้นไม้ชนิดหนึ่ง
OAK โอ๊กจัดอยู่ในประเภทเกสรจากต้นไม้
PINE ต้นสนจัดอยู่ในประเภทของเกสรจากต้นไม้
CYPRESS_PINE สนไซเปรสจัดอยู่ในประเภทเกสรจากต้นไม้
HAZEL เฮเซลจัดอยู่ในประเภทเกสรจากต้นไม้
GRAMINALES พืชในวงศ์หญ้าจัดอยู่ในประเภทละอองเกสรจากหญ้า
RAGWEED แร็กวีดจัดอยู่ในประเภทเกสรจากวัชพืช
MUGWORT จิงจูฉ่ายจัดว่าเป็นเกสรจากวัชพืชชนิดหนึ่ง

PlantDescription

มีข้อมูลทั่วไปเกี่ยวกับพืช ได้แก่ รายละเอียดเกี่ยวกับฤดูกาล รูปทรงและสีพิเศษ ข้อมูลเกี่ยวกับปฏิกิริยาภูมิแพ้ข้ามได้ และรูปภาพพืช

การแสดง JSON
{
  "type": enum (PollenType),
  "family": string,
  "season": string,
  "specialColors": string,
  "specialShapes": string,
  "crossReaction": string,
  "picture": string,
  "pictureCloseup": string
}
ช่อง
type

enum (PollenType)

ประเภทเกสรดอกไม้ของพืช เช่น "GRASS" ดูรายการรหัสที่ใช้ได้ทั้งหมดที่นี่

family

string

ชื่อวงศ์พืชที่มนุษย์อ่านได้ เช่น "Betulaceae (วงศ์เบิร์ช)"

season

string

รายการข้อความอธิบายฤดูกาลที่มีละอองเกสรดอกไม้ ตัวอย่างเช่น "ปลายฤดูหนาว, ฤดูใบไม้ผลิ"

specialColors

string

ข้อความอธิบายสีของใบไม้ เปลือก ดอกไม้ หรือเมล็ดของต้นไม้ที่ช่วยระบุต้นไม้

specialShapes

string

ข้อความอธิบายรูปทรงของใบไม้ เปลือก ดอกไม้ หรือเมล็ดของพืชที่ช่วยระบุพันธุ์พืช

crossReaction

string

ข้อความอธิบายเกี่ยวกับพืชที่มีปฏิกิริยาระหว่างเกสรดอกไม้ ตัวอย่าง: เกสรจากต้นเอลเดอร์ เฮเซล ฮอร์นบีม บีช วิลโลว์ และโอ๊ก

picture

string

ลิงก์ไปยังรูปภาพต้นไม้

pictureCloseup

string

ลิงก์ไปยังรูปภาพระยะใกล้ของต้นไม้