- คำขอ HTTP
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- LatLng
- DayInfo
- วันที่
- 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 | 
 ไม่บังคับ จำนวนสูงสุดของบันทึกข้อมูลรายวันที่จะแสดงต่อ 1 หน้า ค่าเริ่มต้นและค่าสูงสุดคือ 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[] | 
 รายการนี้จะรวมถึงเกสรดอกไม้สูงสุด 3 ประเภท (GRASS, WEED, TREE) ที่ส่งผลต่อตำแหน่งที่ระบุไว้ในคำขอ | 
| plantInfo[] | 
 รายการนี้ประกอบด้วยชนิดเกสรดอกไม้สูงสุด 15 ชนิดที่ส่งผลต่อตำแหน่งที่ระบุไว้ในคำขอ | 
วันที่
แสดงวันที่ในปฏิทินบางส่วนหรือทั้งหมด เช่น วันเกิด มีการระบุเวลาของวันและเขตเวลาไว้ที่อื่นหรือไม่มีนัยสำคัญ วันที่จะสัมพันธ์กับปฏิทินเกรกอเรียน ซึ่งอาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้
- วันที่แบบเต็ม โดยมีค่าปี เดือน และวันที่ไม่ใช่ 0
- 1 เดือนและวัน โดยมี 0 ปี (เช่น วันครบรอบ)
- ปีหนึ่งๆ มี 0 เดือนและมี 0 วัน
- 1 ปีและเดือน โดยมี 0 วัน (เช่น วันที่หมดอายุของบัตรเครดิต)
ประเภทที่เกี่ยวข้อง:
- 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 เพื่อระบุปีเพียงอย่างเดียว หรือ 1 ปีและเดือนที่วันไม่มีนัยสำคัญ | 
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 | 
 การจัดประเภทข้อความของการแปลผลคะแนนตัวเลขดัชนี ดัชนีประกอบด้วย 6 หมวดหมู่ดังนี้ 
 | 
| indexDescription | 
 คำอธิบายข้อความของระดับดัชนีปัจจุบัน | 
| color | 
 สีที่ใช้แสดงคะแนนตัวเลขของดัชนีเกสรดอกไม้ | 
| value | 
 คะแนนที่เป็นตัวเลขของดัชนี ช่วงตัวเลขอยู่ระหว่าง 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 | 
 ปริมาณสีแดงของสีเป็นค่าในช่วง [0, 1] | 
| green | 
 ปริมาณสีเขียวของสีเป็นค่าในช่วง [0, 1] | 
| blue | 
 ปริมาณของสีน้ำเงินเป็นค่าในช่วง [0, 1] | 
| alpha | 
 เศษส่วนของสีนี้ที่ควรใช้กับพิกเซล กล่าวคือ สีของพิกเซลสุดท้ายจะกำหนดโดยสมการต่อไปนี้ 
 หมายความว่าค่า 1.0 จะเท่ากับสีทึบ ในขณะที่ค่า 0.0 คือสีที่โปร่งใสทั้งหมด การดำเนินการนี้จะใช้ข้อความ Wrapper แทนสเกลาร์ Float แบบง่ายเพื่อให้แยกความแตกต่างระหว่างค่าเริ่มต้นกับค่าที่ไม่ได้ตั้งค่าได้ หากละเว้น วัตถุสีนี้จะแสดงเป็นสีทึบ (เสมือนว่าค่าอัลฟ่าได้รับค่าเป็น 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 | 
 การแสดงชื่อวงศ์พืชที่มนุษย์อ่านได้ ตัวอย่างเช่น "Betulaceae (วงศ์เบิร์ช)" | 
| season | 
 รายการข้อความอธิบายฤดูกาลที่มีละอองเกสรดอกไม้ เช่น "ปลายฤดูหนาว ฤดูใบไม้ผลิ" | 
| specialColors | 
 คำอธิบายข้อความของพืช" สีของใบ เปลือกไม้ ดอกไม้ หรือเมล็ดพันธุ์ที่ช่วยระบุพืช | 
| specialShapes | 
 คำอธิบายข้อความของพืช" รูปทรงของใบ เปลือกไม้ ดอกไม้ หรือเมล็ดพันธุ์ที่ช่วยระบุพืช | 
| crossReaction | 
 คำอธิบายข้อความของพืชที่มีปฏิกิริยาต่อกันของเกสรดอกไม้ ตัวอย่าง: เกสรจากต้นเอลเดอร์ เฮเซล ฮอร์นบีม บีช วิลโลว์ และโอ๊ก | 
| picture | 
 ลิงก์ไปยังรูปภาพของต้นไม้ | 
| pictureCloseup | 
 ลิงก์ไปยังภาพระยะใกล้ของต้นไม้ |