O endpoint forecast fornece até cinco dias de informações diárias sobre pólen. É possível controlar as seguintes informações que são mostradas aos usuários:
- Número de dias de previsão
- Código do idioma para campos traduzidos
- Tamanho da página de resposta
- Informações detalhadas sobre as plantas de uma determinada área e o potencial alergênico delas
O API Explorer permite fazer solicitações em tempo real para que você se familiarize com a API e as opções dela:
Sobre as solicitações de previsão
Para solicitar informações diárias de pólen usando o endpoint de previsão, envie uma solicitação GET HTTP para:
https://pollen.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY
Inclua seus parâmetros no URL. A solicitação contém o local para o qual você quer receber a previsão de pólen, o número de dias de previsão e as informações de pólen a serem incluídas na resposta.
Sobre as respostas de previsão
O corpo da resposta fornece o código da região das coordenadas solicitadas e as informações da previsão diária para cada dia solicitado. Se você solicitar informações de mais de um dia, o corpo da resposta também incluirá um token para recuperar a próxima página se as informações não couberem no tamanho da página solicitado.
O corpo da resposta também inclui três objetos:
DayInfo informa a data da previsão representada, junto com PollenTypeInfo e PlantInfo.
PollenTypeInfo informa a sazonalidade dos tipos de pólen disponíveis (
GRASS,TREEeWEED), o índice de pólen e as recomendações de saúde associadas nas coordenadas solicitadas.O PlantInfo informa nomes e descrições de plantas, incluindo sazonalidade, aparência e reações cruzadas, nas coordenadas solicitadas.
Parâmetros básicos
Exemplo de solicitação
O código abaixo mostra como criar uma solicitação básica para uma solicitação forecast:lookup. Neste exemplo, você define o local e o número de dias de informações sobre pólen.
curl -X GET "https://pollen.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY&location.longitude=35.32 &location.latitude=32.32 &days=1"
Exemplo de resposta
A chamada acima gera a seguinte resposta JSON.
{ "regionCode": "IL", "dailyInfo": [ { "date": { "year": 2023, "month": 7, "day": 11 }, "pollenTypeInfo": [ { "code": "GRASS", "displayName": "Grass", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "healthRecommendations": [ "Pollen levels are very low right now. It's a great day to enjoy theoutdoors!" ] }, { "code": "TREE", "displayName": "Tree", "inSeason": false, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "healthRecommendations": [ "Pollen levels are very low right now. It's a great day to enjoy theoutdoors!" ] }, { "code": "WEED", "displayName": "Weed", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "healthRecommendations": [ "Pollen levels are very low right now. It's a great day to enjoy theoutdoors!" ] } ], "plantInfo": [ { "code": "BIRCH", "displayName": "Birch", "inSeason": false, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "plantDescription": { "type": "TREE", "family": "Betulaceae (the Birch family)", "season": "Late winter, spring", "specialColors": "The bark is usually whitish-gray, silver, orsometimes red." , "specialShapes": "Birch leaves are often triangular with jaggededges. The bark on most birch trees has horizontal dark streaks that look like scoring. Birch tree bark is also , "crossReaction": "Alder, Hazel, Hornbeam, Beech, Willow, and Oakwell-known for its paper-like texture and peeling nature." pollen. In addition, there may be a higher risk for food allergies like hazelnuts, almonds, peanuts, pears, apples, , "picture": "https://storage.googleapis.com/pollen-pictures/birch_full.jpg", "pictureCloseup": "https://storage.googleapis.com/pollen-pictures/birch_closeup.jpg" } }, { "code": "OLIVE", "displayName": "Olive" }, { "code": "GRAMINALES", "displayName": "Grasses", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arecherries and carrots." likely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "plantDescription": { "type": "GRASS", "family": "Poaceae", "season": "Late spring, summer", "specialColors": "None", "specialShapes": "The leaves are alternate, long and narrow and theleaf margin is smooth." , "crossReaction": "Plantain (Plantago) pollen. In addition, there maybe a higher risk for food allergies like melons, oranges, tomatoes, peanuts, soy, potato, and other legumes." , "picture": "https://storage.googleapis.com/pollen-pictures/graminales_full.jpg", "pictureCloseup": "https://storage.googleapis.com/pollen-pictures/graminales_closeup.jpg" } }, { "code": "RAGWEED", "displayName": "Ragweed", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 0, "category": "None", "indexDescription": "Pollen levels are very low and are not likelyto trigger allergic reactions" , "color": {} }, "plantDescription": { "type": "WEED", "family": "Asteraceae (the daisy family)", "season": "Late summer, fall", "specialColors": "None", "specialShapes": "The leaves are alternate or opposite, divided andlobed. The leaf margin is smooth or serrated." , "crossReaction": "Mugwort and Goldenrod as well as daisies such asSunflower, Dandelion, and Chamomile." , "picture": "https://storage.googleapis.com/pollen-pictures/ragweed_full.jpg", "pictureCloseup": "https://storage.googleapis.com/pollen-pictures/ragweed_closeup.jpg" } }, { "code": "ALDER", "displayName": "Alder" }, { "code": "MUGWORT", "displayName": "Mugwort", "inSeason": false, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "plantDescription": { "type": "WEED", "family": "Asteraceae (the daisy family)", "season": "Late summer, fall", "specialColors": "The leaves are green on the upper side andgray-green on the lower side." , "specialShapes": "The leaves are alternate, divided and pinnate.", "crossReaction": "Ragweed and Goldenrod pollen as well as daisiessuch as Sunflower, Dandelion and Chamomile. In addition, there may be a higher risk for food allergies like mustard, , "picture": "https://storage.googleapis.com/pollen-pictures/mugwort_full.jpg", "pictureCloseup": "https://storage.googleapis.com/pollen-pictures/mugwort_closeup.jpg" } } ] } ] }peach, celery and various herbs and spices."
Parâmetros adicionais
Exemplo de solicitação
O código abaixo mostra como criar uma solicitação para uma forecast:lookup. Neste exemplo, você define o local, os dias e o idioma de resposta e remove a descrição da planta.
curl -X GET "https://pollen.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY&location.longitude=35.32 &location.latitude=32.32 &days=1 &languageCode=fr &plantsDescription=false"
Exemplo de resposta
A chamada acima gera a seguinte resposta JSON:
{ "regionCode": "IL", "dailyInfo": [ { "date": { "year": 2023, "month": 7, "day": 11 }, "pollenTypeInfo": [ { "code": "GRASS", "displayName": "Herbacée", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Très faible", "indexDescription": "Les personnes extrêmement sensibles au pollensont susceptibles de ressentir des symptômes." , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "healthRecommendations": [ "Les niveaux de pollen sont très faibles actuellement. La journéeest idéale pour profiter du grand air !" ] }, { "code": "TREE", "displayName": "Arbre", "inSeason": false, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Très faible", "indexDescription": "Les personnes extrêmement sensibles au pollensont susceptibles de ressentir des symptômes." , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "healthRecommendations": [ "Les niveaux de pollen sont très faibles actuellement. La journéeest idéale pour profiter du grand air !" ] }, { "code": "WEED", "displayName": "Herbacées", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Très faible", "indexDescription": "Les personnes extrêmement sensibles au pollensont susceptibles de ressentir des symptômes." , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "healthRecommendations": [ "Les niveaux de pollen sont très faibles actuellement. La journéeest idéale pour profiter du grand air !" ] } ], "plantInfo": [ { "code": "BIRCH", "displayName": "Bouleau", "inSeason": false, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Très faible", "indexDescription": "Les personnes extrêmement sensibles au pollensont susceptibles de ressentir des symptômes." , "color": { "green": 0.61960787, "blue": 0.22745098 } } }, { "code": "OLIVE", "displayName": "Olivier" }, { "code": "GRAMINALES", "displayName": "Graminées", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Très faible", "indexDescription": "Les personnes extrêmement sensibles au pollensont susceptibles de ressentir des symptômes." , "color": { "green": 0.61960787, "blue": 0.22745098 } } }, { "code": "RAGWEED", "displayName": "Ambroisie", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 0, "category": "Aucun", "indexDescription": "Les niveaux de pollen sont très faibles et ontpeu de risque de déclencher des réactions allergiques." , "color": {} } }, { "code": "ALDER", "displayName": "Aulne" }, { "code": "MUGWORT", "displayName": "Armoise", "inSeason": false, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Très faible", "indexDescription": "Les personnes extrêmement sensibles au pollensont susceptibles de ressentir des symptômes." , "color": { "green": 0.61960787, "blue": 0.22745098 } } } ] } ] }
Limites de tamanho da página
Exemplo de solicitação
O código a seguir mostra como criar uma solicitação para uma forecast:lookup. Nesse
exemplo, você define o local, o número de dias previstos (neste caso, 4)
e um limite de tamanho de página de 1. Essa solicitação retorna a previsão apenas para o primeiro dia. A resposta inclui a propriedade nextPageToken, que você usa em uma segunda solicitação para acessar o dia 2 de 4.
curl -X GET "https://pollen.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY&location.longitude=35.32 &location.latitude=32.32 &days=4 &pageSize=1"
Exemplo de resposta
A chamada acima gera a seguinte resposta JSON, incluindo um
nextPageToken. Você usa nextPageToken em uma segunda solicitação para acessar o próximo dia na previsão.
{ "regionCode": "IL", "dailyInfo": [ { "date": { "year": 2023, "month": 7, "day": 14 }, "pollenTypeInfo": [ { "code": "GRASS", "displayName": "Grass", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 2, "category": "Low", "indexDescription": "People with high allergy to pollen are likelyto experience symptoms" , "color": { "red": 0.5176471, "green": 0.8117647, "blue": 0.2 } }, "healthRecommendations": [ "It's a good day for outdoor activities since pollen levels arelow." , "Do you know which plants cause your pollen allergy? Check out thepollen data to be prepared." ] }, { "code": "TREE", "displayName": "Tree", "inSeason": false, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "healthRecommendations": [ "Pollen levels are very low right now. It's a great day to enjoythe outdoors!" ] }, { "code": "WEED", "displayName": "Weed", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "healthRecommendations": [ "Pollen levels are very low right now. It's a great day to enjoy theoutdoors!" ] } ], "plantInfo": [ { "code": "BIRCH", "displayName": "Birch", "inSeason": false, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "plantDescription": { "type": "TREE", "family": "Betulaceae (the Birch family)", "season": "Late winter, spring", "specialColors": "The bark is usually whitish-gray, silver, orsometimes red." , "specialShapes": "Birch leaves are often triangular with jaggededges. The bark on most birch trees has horizontal dark streaks that look like scoring. Birch tree bark is also , "crossReaction": "Alder, Hazel, Hornbeam, Beech, Willow, and Oakwell-known for its paper-like texture and peeling nature." pollen. In addition, there may be a higher risk for food allergies like hazelnuts, almonds, peanuts, pears, apples, , "picture": "https://storage.googleapis.com/pollen-pictures/birch_full.jpg", "pictureCloseup": "https://storage.googleapis.com/pollen-pictures/birch_closeup.jpg" } }, { "code": "OLIVE", "displayName": "Olive" }, { "code": "GRAMINALES", "displayName": "Grasses", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 2, "category": "Low", "indexDescription": "People with high allergy to pollen are likelycherries and carrots." to experience symptoms" , "color": { "red": 0.5176471, "green": 0.8117647, "blue": 0.2 } }, "plantDescription": { "type": "GRASS", "family": "Poaceae", "season": "Late spring, summer", "specialColors": "None", "specialShapes": "The leaves are alternate, long and narrow and theleaf margin is smooth." , "crossReaction": "Plantain (Plantago) pollen. In addition, there maybe a higher risk for food allergies like melons, oranges, tomatoes, peanuts, soy, potato, and other legumes." , "picture": "https://storage.googleapis.com/pollen-pictures/graminales_full.jpg", "pictureCloseup": "https://storage.googleapis.com/pollen-pictures/graminales_closeup.jpg" } }, { "code": "RAGWEED", "displayName": "Ragweed", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 0, "category": "None", "indexDescription": "Pollen levels are very low and are not likelyto trigger allergic reactions" , "color": {} }, "plantDescription": { "type": "WEED", "family": "Asteraceae (the daisy family)", "season": "Late summer, fall", "specialColors": "None", "specialShapes": "The leaves are alternate or opposite, divided andlobed. The leaf margin is smooth or serrated." , "crossReaction": "Mugwort and Goldenrod as well as daisies such asSunflower, Dandelion, and Chamomile." , "picture": "https://storage.googleapis.com/pollen-pictures/ragweed_full.jpg", "pictureCloseup": "https://storage.googleapis.com/pollen-pictures/ragweed_closeup.jpg" } }, { "code": "ALDER", "displayName": "Alder" }, { "code": "MUGWORT", "displayName": "Mugwort", "inSeason": false, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "plantDescription": { "type": "WEED", "family": "Asteraceae (the daisy family)", "season": "Late summer, fall", "specialColors": "The leaves are green on the upper side andgray-green on the lower side." , "specialShapes": "The leaves are alternate, divided and pinnate.", "crossReaction": "Ragweed and Goldenrod pollen as well as daisiessuch as Sunflower, Dandelion and Chamomile. In addition, there may be a higher risk for food allergies like mustard, , "picture": "https://storage.googleapis.com/pollen-pictures/mugwort_full.jpg", "pictureCloseup": "https://storage.googleapis.com/pollen-pictures/mugwort_closeup.jpg" } } ] } ], "nextPageToken": "CAESdApadHlwZS5nb29nbGVhcGlzLm..." }peach, celery and various herbs and spices."
Para acessar a página 2, insira nextPageToken na solicitação. A resposta
inclui o nextPageToken, que pode ser usado para acessar o dia 3 da
previsão.
curl -X GET "https://pollen.googleapis.com/v1/forecast:lookup?key=YOUR_API_KEY&location.longitude=35.32 &location.latitude=32.32 &days=4 &pageSize=1 &pageToken=CAESdApadHlwZS5nb29nbGVhcGlzLm..."
A resposta fornece informações sobre o dia 2 da previsão de pólen:
{ "regionCode": "IL", "dailyInfo": [ { "date": { "year": 2023, "month": 7, "day": 15 }, "pollenTypeInfo": [ { "code": "GRASS", "displayName": "Grass", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 2, "category": "Low", "indexDescription": "People with high allergy to pollen are likely to experience symptoms", "color": { "red": 0.5176471, "green": 0.8117647, "blue": 0.2 } }, "healthRecommendations": [ "It's a good day for outdoor activities since pollen levels are low.", "Do you know which plants cause your pollen allergy? Check out thepollen data to be prepared." ] }, { "code": "TREE", "displayName": "Tree", "inSeason": false, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "healthRecommendations": [ "Pollen levels are very low right now. It's a great day to enjoy theoutdoors!" ] }, { "code": "WEED", "displayName": "Weed", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "healthRecommendations": [ "Pollen levels are very low right now. It's a great day to enjoy theoutdoors!" ] } ], "plantInfo": [ { "code": "BIRCH", "displayName": "Birch", "inSeason": false, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "plantDescription": { "type": "TREE", "family": "Betulaceae (the Birch family)", "season": "Late winter, spring", "specialColors": "The bark is usually whitish-gray, silver, orsometimes red." , "specialShapes": "Birch leaves are often triangular with jagged edges.The bark on most birch trees has horizontal dark streaks that look like scoring. Birch tree bark is also , "crossReaction": "Alder, Hazel, Hornbeam, Beech, Willow, and Oakwell-known for its paper-like texture and peeling nature." pollen. In addition, there may be a higher risk for food allergies like hazelnuts, almonds, peanuts, pears, apples, cherries and carrots." , "picture": "https://storage.googleapis.com/pollen-pictures/birch_full.jpg", "pictureCloseup": "https://storage.googleapis.com/pollen-pictures/birch_closeup.jpg" } }, { "code": "OLIVE", "displayName": "Olive" }, { "code": "GRAMINALES", "displayName": "Grasses", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 2, "category": "Low", "indexDescription": "People with high allergy to pollen are likelyto experience symptoms" , "color": { "red": 0.5176471, "green": 0.8117647, "blue": 0.2 } }, "plantDescription": { "type": "GRASS", "family": "Poaceae", "season": "Late spring, summer", "specialColors": "None", "specialShapes": "The leaves are alternate, long and narrow and theleaf margin is smooth." , "crossReaction": "Plantain (Plantago) pollen. In addition, there maybe a higher risk for food allergies like melons, oranges, tomatoes, peanuts, soy, potato, and other legumes." , "picture": "https://storage.googleapis.com/pollen-pictures/graminales_full.jpg", "pictureCloseup": "https://storage.googleapis.com/pollen-pictures/graminales_closeup.jpg" } }, { "code": "RAGWEED", "displayName": "Ragweed", "inSeason": true, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 0, "category": "None", "indexDescription": "Pollen levels are very low and are not likelyto trigger allergic reactions" , "color": {} }, "plantDescription": { "type": "WEED", "family": "Asteraceae (the daisy family)", "season": "Late summer, fall", "specialColors": "None", "specialShapes": "The leaves are alternate or opposite, divided andlobed. The leaf margin is smooth or serrated." , "crossReaction": "Mugwort and Goldenrod as well as daisies such asSunflower, Dandelion, and Chamomile." , "picture": "https://storage.googleapis.com/pollen-pictures/ragweed_full.jpg", "pictureCloseup": "https://storage.googleapis.com/pollen-pictures/ragweed_closeup.jpg" } }, { "code": "ALDER", "displayName": "Alder" }, { "code": "MUGWORT", "displayName": "Mugwort", "inSeason": false, "indexInfo": { "code": "UPI", "displayName": "Universal Pollen Index", "value": 1, "category": "Very Low", "indexDescription": "People with very high allergy to pollen arelikely to experience symptoms" , "color": { "green": 0.61960787, "blue": 0.22745098 } }, "plantDescription": { "type": "WEED", "family": "Asteraceae (the daisy family)", "season": "Late summer, fall", "specialColors": "The leaves are green on the upper side andgray-green on the lower side." , "specialShapes": "The leaves are alternate, divided and pinnate.", "crossReaction": "Ragweed and Goldenrod pollen as well as daisiessuch as Sunflower, Dandelion and Chamomile. In addition, there may be a higher risk for food allergies like mustard, , "picture": "https://storage.googleapis.com/pollen-pictures/mugwort_full.jpg", "pictureCloseup": "https://storage.googleapis.com/pollen-pictures/mugwort_closeup.jpg" } } ] } ], "nextPageToken": "CAISdApadHlwZS5nb29nbGVhcGlzLm..." }peach, celery and various herbs and spices."