- درخواست HTTP
- پارامترهای پرس و جو
- درخواست بدنه
- بدنه پاسخ
- دامنههای مجوز
- روز پیشبینی
- تاریخ
- بخش روز پیشبینی
- رویدادهای سان
- رویدادهای ماه
- فاز ماه
پیشبینیهای روزانه تا 10 روز را در یک مکان مشخص، از روز جاری، برمیگرداند.
درخواست HTTP
GET https://weather.googleapis.com/v1/forecast/days:lookup
این URL از سینتکس Transcoding در gRPC استفاده میکند.
پارامترهای پرس و جو
| پارامترها | |
|---|---|
location | الزامی. مکانی که قرار است پیشبینی روزانه آب و هوای آن را دریافت کنید. |
unitsSystem | اختیاری. سیستم واحد مورد استفاده برای شرایط آب و هوایی برگردانده شده. در صورت عدم ارائه، شرایط آب و هوایی برگردانده شده در سیستم متریک خواهد بود (پیش فرض = METRIC). |
pageSize | اختیاری. حداکثر تعداد رکوردهای پیشبینی روزانه برای برگرداندن در هر صفحه - مقداری از ۱ تا ۱۰ (شامل). مقدار پیشفرض ۵ است. |
pageToken | اختیاری. یک توکن صفحه که از درخواست قبلی دریافت شده است. برای بازیابی صفحه بعدی استفاده میشود. |
days | اختیاری. تعداد کل روزهایی که از روز جاری قابل واکشی هستند را محدود میکند - مقداری از ۱ تا ۱۰ (شامل). مقدار پیشفرض، حداکثر مقدار مجاز ۱۰ است. |
languageCode | اختیاری. به کلاینت اجازه میدهد زبان پاسخ را انتخاب کند. اگر دادهها برای آن زبان ارائه نشوند، API از نزدیکترین مورد منطبق استفاده میکند. مقادیر مجاز بر اساس استاندارد IETF BCP-47 هستند. مقدار پیشفرض "en" است. |
درخواست بدنه
بدنه درخواست باید خالی باشد.
بدنه پاسخ
پاسخ برای RPC مربوط به days.lookup.
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{ "forecastDays": [ { object ( |
| فیلدها | |
|---|---|
forecastDays[] | پیشبینی روزانه، بر اساس تعداد روزها و اندازه صفحه مشخص شده در درخواست، ثبت میشود. |
timeZone | منطقه زمانی در محل درخواستی. |
nextPageToken | توکن برای بازیابی صفحه بعدی. |
دامنههای مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/cloud-platform
روز پیشبینی
نشاندهندهی یک رکورد پیشبینی روزانه در یک مکان مشخص است.
| نمایش JSON |
|---|
{ "interval": { object ( |
| فیلدها | |
|---|---|
interval | بازه زمانی UTC که این روز پیشبینیشده در آن شروع (شامل) و پایان (منحصراً) میشود. توجه: یک روز از ساعت ۷ صبح شروع میشود و ساعت ۷ صبح روز بعد، به وقت محلی، پایان مییابد. برای مثال: اگر منطقه زمانی محلی UTC-7 باشد، بازه زمانی از ساعت |
displayDate | تاریخ محلی در منطقه زمانی مکان (زمان رسمی) که این پیشبینی روزانه برای آن محاسبه میشود. این فیلد ممکن است برای اهداف نمایشی در کلاینت استفاده شود. |
daytimeForecast | شرایط آب و هوایی پیشبینی شده برای بخش روزانه روز (۷ صبح تا ۷ بعد از ظهر به وقت محلی). |
nighttimeForecast | شرایط آب و هوایی پیشبینیشده برای بخش شبانه روز (از ساعت ۷ عصر تا ۷ صبح روز بعد، به وقت محلی). |
maxTemperature | حداکثر (بالاترین) دما در طول روز. |
minTemperature | حداقل (پایینترین) دما در طول روز. |
feelsLikeMaxTemperature | حداکثر (بالاترین) دمایی که در طول روز احساس میشود. |
feelsLikeMinTemperature | حداقل (پایینترین) دمایی که در طول روز احساس میشود. |
maxHeatIndex | حداکثر دمای شاخص گرما در طول روز. |
sunEvents | وقایع مربوط به خورشید (مثلاً طلوع خورشید، غروب خورشید). |
moonEvents | رویدادهای مربوط به ماه (مثلاً طلوع ماه، غروب ماه). |
تاریخ
نشان دهنده یک تاریخ تقویمی کامل یا جزئی، مانند تاریخ تولد است. زمان روز و منطقه زمانی یا در جای دیگری مشخص شدهاند یا اهمیت چندانی ندارند. تاریخ نسبت به تقویم میلادی است. این میتواند یکی از موارد زیر را نشان دهد:
- یک تاریخ کامل، با مقادیر سال، ماه و روز غیر صفر.
- یک ماه و یک روز، با یک سال صفر (مثلاً یک سالگرد).
- یک سال به تنهایی، با یک ماه صفر و یک روز صفر.
- یک سال و یک ماه، با یک روز صفر (برای مثال، تاریخ انقضای کارت اعتباری).
انواع مرتبط:
-
google.type.TimeOfDay -
google.type.DateTime -
google.protobuf.Timestamp
| نمایش JSON |
|---|
{ "year": integer, "month": integer, "day": integer } |
| فیلدها | |
|---|---|
year | سال تاریخ. باید از ۱ تا ۹۹۹۹ باشد، یا برای مشخص کردن تاریخ بدون سال، ۰ باشد. |
month | ماه سال. باید از ۱ تا ۱۲ باشد، یا برای مشخص کردن سال بدون ماه و روز، ۰ باشد. |
day | روز ماه. باید از ۱ تا ۳۱ باشد و برای سال و ماه معتبر باشد، یا ۰ برای مشخص کردن یک سال به تنهایی یا یک سال و ماه که روز در آن مهم نیست. |
بخش روز پیشبینی
نشاندهندهی رکورد پیشبینی برای بخشی از روز است.
| نمایش JSON |
|---|
{ "interval": { object ( |
| فیلدها | |
|---|---|
interval | تاریخ و زمان UTC که این بخش از روز شروع (شامل) و پایان (منحصراً) میشود. توجه: بخشی از روز از ساعت ۷ صبح شروع و ساعت ۷ عصر همان روز، به وقت محلی، پایان مییابد. به عنوان مثال: اگر منطقه زمانی محلی UTC-7 باشد، بازه زمانی روز از ساعت |
weatherCondition | وضعیت آب و هوای پیشبینی شده. |
precipitation | میزان بارندگی پیشبینی شده |
wind | میانگین جهت باد و حداکثر سرعت و تندباد. |
iceThickness | مقدار یخ انباشته شده برای آن بخش از روز. |
relativeHumidity | درصد رطوبت نسبی پیشبینیشده (مقادیر از ۰ تا ۱۰۰). |
uvIndex | حداکثر شاخص فرابنفش پیشبینیشده (UV). |
thunderstormProbability | احتمال متوسط رعد و برق. |
cloudCover | میانگین درصد پوشش ابر |
رویدادهای سان
نشان دهنده وقایع مربوط به خورشید است (مثلاً طلوع خورشید، غروب خورشید).
| نمایش JSON |
|---|
{ "sunriseTime": string, "sunsetTime": string } |
| فیلدها | |
|---|---|
sunriseTime | ساعتی که خورشید طلوع میکند. نکته: در برخی موارد خاص (مثلاً شمال دایره قطبی) ممکن است زمان طلوع آفتاب برای یک روز وجود نداشته باشد. در این موارد، این فیلد تنظیم نخواهد شد. از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: |
sunsetTime | ساعتی که خورشید غروب میکند. نکته: در برخی موارد خاص (مثلاً شمال دایره قطبی) ممکن است زمان غروب آفتاب برای یک روز وجود نداشته باشد. در این موارد، این فیلد تنظیم نخواهد شد. از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: |
رویدادهای ماه
رویدادهای مربوط به ماه (مثلاً طلوع ماه، غروب ماه) را نشان میدهد.
| نمایش JSON |
|---|
{
"moonriseTimes": [
string
],
"moonsetTimes": [
string
],
"moonPhase": enum ( |
| فیلدها | |
|---|---|
moonriseTimes[] | زمانی که لبه بالایی ماه در بالای افق ظاهر میشود (به https://en.wikipedia.org/wiki/Moonrise_and_moonset مراجعه کنید) . توجه: در بیشتر موارد، یک زمان طلوع ماه در هر روز وجود خواهد داشت. در موارد دیگر، لیست ممکن است خالی باشد (مثلاً وقتی ماه بعد از نیمه شب روز بعد طلوع میکند). با این حال، در موارد منحصر به فرد (مثلاً در مناطق قطبی)، لیست ممکن است شامل بیش از یک مقدار باشد. در این موارد، مقادیر به ترتیب صعودی مرتب میشوند. از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: |
moonsetTimes[] | زمانی که لبه بالایی ماه در زیر افق ناپدید میشود (به https://en.wikipedia.org/wiki/Moonrise_and_moonset مراجعه کنید) . توجه: در بیشتر موارد، برای هر روز یک زمان مشخص برای ماه وجود دارد. در موارد دیگر، لیست ممکن است خالی باشد (مثلاً وقتی ماه بعد از نیمهشب روز بعد غروب میکند). با این حال، در موارد منحصر به فرد (مثلاً در مناطق قطبی)، لیست ممکن است شامل بیش از یک مقدار باشد. در این موارد، مقادیر به ترتیب صعودی مرتب میشوند. از RFC 3339 استفاده میکند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده میکند. آفستهای غیر از "Z" نیز پذیرفته میشوند. مثالها: |
moonPhase | فاز ماه (معروف به فاز قمری). |
فاز ماه
فاز ماه (یا فاز قمری) را نشان میدهد.
| انومها | |
|---|---|
MOON_PHASE_UNSPECIFIED | فاز ماه نامشخص. |
NEW_MOON | ماه توسط خورشید روشن نمیشود. |
WAXING_CRESCENT | ماه در نیمکره شمالی 🌒 در سمت راست خود 0% تا 50% و در نیمکره جنوبی 🌘 در سمت چپ خود 🌘 روشن است. |
FIRST_QUARTER | ماه در نیمکره شمالی 🌓 در سمت راست خود 50.1٪ و در نیمکره جنوبی 🌗 در سمت چپ خود 50.1٪ روشن است. |
WAXING_GIBBOUS | ماه در نیمکره شمالی 🌔 در سمت راست خود 50٪ تا 100٪ و در نیمکره جنوبی 🌖 در سمت چپ خود روشن میشود. |
FULL_MOON | ماه کاملاً روشن است. |
WANING_GIBBOUS | ماه در نیمکره شمالی 🌖 در سمت چپ خود 50٪ تا 100٪ و در نیمکره جنوبی 🌔 در سمت راست خود روشن میشود. |
LAST_QUARTER | ماه در نیمکره شمالی 🌗 در سمت چپ خود 50.1٪ و در نیمکره جنوبی 🌓 در سمت راست خود 50.1٪ روشن است. |
WANING_CRESCENT | ماه در نیمکره شمالی 🌘 در سمت چپ خود 0% تا 50% و در نیمکره جنوبی 🌒 در سمت راست خود 🌒 روشن میشود. |