- Permintaan HTTP
- Parameter kueri
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- LatLng
- DayInfo
- Tanggal
- PollenTypeInfo
- PollenType
- IndexInfo
- Indeks
- Warna
- PlantInfo
- Tanaman
- PlantDescription
Menampilkan informasi serbuk sari harian hingga 5 hari di lebih dari 65 negara, hingga resolusi 1 km.
Permintaan HTTP
GET https://pollen.googleapis.com/v1/forecast:lookup
URL menggunakan sintaksis gRPC Transcoding.
Parameter kueri
Parameter | |
---|---|
location |
Wajib. Bujur dan lintang tempat API menelusuri data perkiraan serbuk sari. |
days |
Wajib. Angka yang menunjukkan jumlah hari perkiraan yang akan diminta (nilai minimum 1, nilai maksimum adalah 5). |
pageSize |
Opsional. Jumlah maksimum catatan info harian yang akan ditampilkan per halaman. Nilai default dan maksimum adalah 5 (data selama 5 hari). |
pageToken |
Opsional. Token halaman diterima dari panggilan harian sebelumnya. Digunakan untuk mengambil halaman berikutnya. Perhatikan bahwa saat memberikan nilai untuk token halaman, semua parameter permintaan lain yang diberikan harus cocok dengan panggilan sebelumnya yang menyediakan token halaman. |
languageCode |
Opsional. Memungkinkan klien memilih bahasa respons. Jika data tidak dapat diberikan untuk bahasa tersebut, API akan menggunakan kecocokan terdekat. Nilai yang diizinkan bergantung pada standar IETF BCP-47. Nilai defaultnya adalah "en". |
plantsDescription |
Opsional. Berisi informasi umum tentang tanaman, termasuk detail musimnya, bentuk dan warna khusus, informasi tentang reaksi silang alergi, dan foto tanaman. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"regionCode": string,
"dailyInfo": [
{
object ( |
Kolom | |
---|---|
regionCode |
Kode ISO_3166-1 alpha-2 untuk negara/wilayah yang sesuai dengan lokasi yang diberikan dalam permintaan. Kolom ini dapat dihapus dari respons jika lokasi yang diberikan dalam permintaan berada di wilayah yang disengketakan. |
dailyInfo[] |
Wajib. Objek ini berisi informasi prakiraan harian untuk setiap hari yang diminta. |
nextPageToken |
Opsional. Token untuk mengambil halaman berikutnya. |
Cakupan otorisasi
Memerlukan cakupan OAuth berikut ini:
https://www.googleapis.com/auth/cloud-platform
Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
LatLng
Objek yang merepresentasikan pasangan garis lintang/bujur. Objek ini dinyatakan sebagai pasangan double untuk mewakili derajat lintang dan derajat bujur. Kecuali ditentukan lain, objek ini harus sesuai dengan standar WGS84. Nilai harus berada dalam rentang yang dinormalisasi.
Representasi JSON |
---|
{ "latitude": number, "longitude": number } |
Kolom | |
---|---|
latitude |
Lintang dalam derajat. Harus dalam rentang [-90.0, +90.0]. |
longitude |
Bujur dalam derajat. Harus dalam rentang [-180.0, +180.0]. |
DayInfo
Objek ini berisi informasi prakiraan harian untuk setiap hari yang diminta.
Representasi JSON |
---|
{ "date": { object ( |
Kolom | |
---|---|
date |
Tanggal dalam UTC saat data perkiraan serbuk sari ditampilkan. |
pollenTypeInfo[] |
Daftar ini akan menyertakan (hingga) tiga jenis serbuk sari (rumput, gulma, pohon) yang memengaruhi lokasi yang ditentukan dalam permintaan. |
plantInfo[] |
Daftar ini akan mencakup (hingga) 15 spesies serbuk sari yang memengaruhi lokasi yang ditentukan dalam permintaan. |
Tanggal
Mewakili seluruh atau sebagian tanggal kalender, seperti ulang tahun. Waktu dan zona waktu ditentukan di tempat lain atau tidak signifikan. Tanggal tersebut relatif terhadap Kalender Gregorian. Ini dapat mewakili salah satu hal berikut:
- Tanggal lengkap, dengan nilai tahun, bulan, dan hari bukan nol.
- Bulan dan hari, dengan nol tahun (misalnya, hari jadi).
- Satu tahun saja, dengan bulan nol dan hari nol.
- Tahun dan bulan, dengan nol hari (misalnya, tanggal habis masa berlaku kartu kredit).
Jenis terkait:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
Representasi JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
Kolom | |
---|---|
year |
Tahun dari tanggal. Harus dari 1 hingga 9999, atau 0 untuk menentukan tanggal tanpa tahun. |
month |
Bulan dalam setahun. Harus dari 1 hingga 12, atau 0 untuk menentukan tahun tanpa bulan dan hari. |
day |
Hari dalam sebulan. Harus dari 1 sampai 31 dan berlaku untuk tahun dan bulan, atau 0 untuk menentukan tahun saja atau tahun dan bulan jika hari dianggap tidak signifikan. |
PollenTypeInfo
Objek ini berisi indeks jenis serbuk sari dan informasi rekomendasi kesehatan tentang jenis serbuk sari tertentu.
Representasi JSON |
---|
{ "code": enum ( |
Kolom | |
---|---|
code |
Nama kode jenis serbuk sari. Misalnya: "GRASS" |
displayName |
Representasi nama jenis serbuk sari yang dapat dibaca manusia. Contoh: "Rumput" |
indexInfo |
Berisi data Universal Pollen Index (UPI) untuk jenis serbuk sari. |
healthRecommendations[] |
Daftar tekstual penjelasan, terkait dengan wawasan kesehatan berdasarkan kadar serbuk sari saat ini. |
inSeason |
Indikasi apakah tanaman sedang musim atau tidak. |
PollenType
Kode Jenis Serbuk Sari
Enum | |
---|---|
POLLEN_TYPE_UNSPECIFIED |
Jenis tanaman tidak ditentukan. |
GRASS |
Jenis serbuk sari rumput. |
TREE |
Jenis serbuk sari pohon. |
WEED |
Jenis serbuk sari gulma. |
IndexInfo
Objek ini berisi data yang mewakili nilai indeks serbuk sari tertentu, kategori, dan deskripsi.
Representasi JSON |
---|
{ "code": enum ( |
Kolom | |
---|---|
code |
Kode indeks. Kolom ini mewakili indeks untuk tujuan pemrograman dengan menggunakan {i>snake case<i}, bukan spasi. Contoh: "UPI". |
displayName |
Representasi nama indeks yang dapat dibaca manusia. Contoh: "Indeks Serbuk sari Universal". |
category |
Klasifikasi teks interpretasi skor numerik indeks. Indeks ini terdiri dari enam kategori:
|
indexDescription |
Penjelasan tekstual tentang level indeks saat ini. |
color |
Warna yang digunakan untuk merepresentasikan skor numerik Indeks Serbuk sari. |
value |
Skor numerik indeks. Rentang numerik adalah antara 0 dan 5. |
Indeks
Kode Indeks
Enum | |
---|---|
INDEX_UNSPECIFIED |
Indeks tidak ditentukan. |
UPI |
Indeks Serbuk sari Universal. |
Warna
Mewakili warna dalam ruang warna RGBA. Representasi ini dirancang untuk kemudahan konversi ke dan dari representasi warna dalam berbagai bahasa dengan mengutamakan keringkasan. Misalnya, kolom representasi ini dapat dengan mudah diberikan ke konstruktor java.awt.Color
di Java; kolom ini juga dapat diberikan dengan mudah ke metode +colorWithRed:green:blue:alpha
UIColor di iOS; dan, hanya dengan sedikit usaha, kolom dapat dengan mudah diformat menjadi string rgba()
CSS di JavaScript.
Halaman referensi ini tidak memiliki informasi tentang ruang warna mutlak yang harus digunakan untuk menafsirkan nilai RGB—misalnya, sRGB, Adobe RGB, DCI-P3, dan BT.2020. Secara default, aplikasi harus mengasumsikan ruang warna sRGB.
Saat kesetaraan warna perlu ditentukan, implementasinya, kecuali jika didokumentasikan lain, perlakukan dua warna sebagai sama jika semua nilai merah, hijau, biru, dan alfa masing-masing berbeda maksimal 1e-5
.
Contoh (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();
}
// ...
Contoh (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;
}
// ...
Contoh (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('');
};
// ...
Representasi JSON |
---|
{ "red": number, "green": number, "blue": number, "alpha": number } |
Kolom | |
---|---|
red |
Jumlah merah dalam warna sebagai nilai dalam interval [0, 1]. |
green |
Jumlah hijau dalam warna sebagai nilai dalam interval [0, 1]. |
blue |
Jumlah biru dalam warna sebagai nilai dalam interval [0, 1]. |
alpha |
Fraksi warna ini yang harus diterapkan ke piksel. Yaitu, warna piksel akhir ditentukan oleh persamaan:
Ini berarti bahwa nilai 1,0 berarti warna solid, sedangkan nilai 0,0 berarti warna yang sepenuhnya transparan. Kode ini menggunakan pesan wrapper, bukan skalar float sederhana sehingga memungkinkan untuk membedakan antara nilai default dan nilai yang tidak disetel. Jika dihilangkan, objek warna ini dirender sebagai warna solid (seolah-olah nilai alfa telah secara eksplisit diberi nilai 1,0). |
PlantInfo
Objek ini berisi informasi harian tentang tanaman tertentu.
Representasi JSON |
---|
{ "code": enum ( |
Kolom | |
---|---|
code |
Nama kode tanaman. Misalnya: "COTTONWOOD". Daftar semua kode yang tersedia dapat ditemukan di sini. |
displayName |
Representasi nama tanaman yang dapat dibaca manusia. Contoh: “Cottonwood". |
indexInfo |
Objek ini berisi data yang mewakili nilai indeks serbuk sari tertentu, kategori, dan deskripsi. |
plantDescription |
Berisi informasi umum tentang tanaman, termasuk detail musimnya, bentuk dan warna khusus, informasi tentang reaksi silang alergi, dan foto tanaman. |
inSeason |
Indikasi apakah tanaman sedang musim atau tidak. |
Tanaman
Mencantumkan tanaman yang tersedia dengan beragam ketersediaan di seluruh lokasi.
Enum | |
---|---|
PLANT_UNSPECIFIED |
Kode tanaman tidak ditentukan. |
ALDER |
Alder diklasifikasikan sebagai jenis serbuk sari pohon. |
ASH |
Abu diklasifikasikan sebagai jenis serbuk sari pohon. |
BIRCH |
Birch diklasifikasikan sebagai jenis serbuk sari pohon. |
COTTONWOOD |
Kapas diklasifikasikan sebagai jenis serbuk sari pohon. |
ELM |
Elm diklasifikasikan sebagai jenis serbuk sari pohon. |
MAPLE |
Maple diklasifikasikan sebagai jenis serbuk sari pohon. |
OLIVE |
Zaitun diklasifikasikan sebagai jenis serbuk sari pohon. |
JUNIPER |
Juniper diklasifikasikan sebagai jenis serbuk sari pohon. |
OAK |
Ek diklasifikasikan sebagai jenis serbuk sari pohon. |
PINE |
Pinus diklasifikasikan sebagai jenis serbuk sari pohon. |
CYPRESS_PINE |
Pinus cemara diklasifikasikan sebagai jenis serbuk sari pohon. |
HAZEL |
Hazel diklasifikasikan sebagai jenis serbuk sari pohon. |
GRAMINALES |
Graminales diklasifikasikan sebagai jenis serbuk sari rumput. |
RAGWEED |
Ragweed diklasifikasikan sebagai jenis serbuk sari gulma. |
MUGWORT |
Mugwort diklasifikasikan sebagai jenis serbuk sari gulma. |
PlantDescription
Berisi informasi umum tentang tanaman, termasuk detail musimnya, bentuk dan warna khusus, informasi tentang reaksi silang alergi, dan foto tanaman.
Representasi JSON |
---|
{
"type": enum ( |
Kolom | |
---|---|
type |
Jenis serbuk sari tanaman. Misalnya: "GRASS". Daftar semua kode yang tersedia dapat ditemukan di sini. |
family |
Representasi nama keluarga tanaman yang dapat dibaca manusia. Contoh: "Betulaceae (keluarga Birch)". |
season |
Daftar tekstual penjelasan tentang musim di mana serbuk sari aktif. Contoh: "Akhir musim dingin, musim semi". |
specialColors |
Deskripsi tekstual tentang warna daun, kulit kayu, bunga, atau biji tanaman yang membantu mengidentifikasi tanaman. |
specialShapes |
Deskripsi tekstual tentang bentuk daun, kulit kayu, bunga, atau biji tanaman yang membantu mengidentifikasi tanaman. |
crossReaction |
Deskripsi tekstual tanaman reaksi silang serbuk sari. Contoh: Serbuk sari Alder, Hazel, Hornbeam, Beech, Willow, dan Ek. |
picture |
Link ke gambar tanaman. |
pictureCloseup |
Link ke gambar tanaman dari jarak dekat. |