Package google.research.floodforecasting.v1

شاخص

FloodsApi

یک سرویس API خارجی برای پیش بینی سیل.

BatchGetGaugeModels

rpc BatchGetGaugeModels( BatchGetGaugeModelsRequest ) returns ( BatchGetGaugeModelsResponse )

فراداده مدل هیدرولوژیکی فعلی را برای چند سنج دریافت کنید.

BatchGetGauges

rpc BatchGetGauges( BatchGetGaugesRequest ) returns ( BatchGetGaugesResponse )

دریافت ابرداده در مورد چندین سنج.

GetGauge

rpc GetGauge( GetGaugeRequest ) returns ( Gauge )

دریافت فراداده در مورد یک سنج.

GetGaugeModel

rpc GetGaugeModel( GetGaugeModelRequest ) returns ( GaugeModel )

فراداده مدل هیدرولوژیکی فعلی را برای یک سنج معین دریافت کنید.

GetSerializedPolygon

rpc GetSerializedPolygon( GetSerializedPolygonRequest ) returns ( SerializedPolygon )

یک چند ضلعی سریالی دریافت کنید. شناسه‌های اینها در سایر پاسخ‌های API ظاهر می‌شوند و شما می‌توانید از این شناسه‌ها در اینجا استفاده کنید. برای مثال، InundationMap در FloodStatus ببینید.

QueryGaugeForecasts

rpc QueryGaugeForecasts( QueryGaugeForecastsRequest ) returns ( QueryGaugeForecastsResponse )

پیش بینی سنج پرس و جو

QueryLatestFloodStatusByGaugeIds

rpc QueryLatestFloodStatusByGaugeIds( QueryLatestFloodStatusByGaugeIdsRequest ) returns ( QueryLatestFloodStatusByGaugeIdsResponse )

آخرین وضعیت سیل را با شناسه سنج جویا شوید.

SearchGaugesByArea

rpc SearchGaugesByArea( SearchGaugesByAreaRequest ) returns ( SearchGaugesByAreaResponse )

جستجو برای سنج بر اساس منطقه جغرافیایی.

توجه: گیج‌ها گاهی اضافه یا حذف می‌شوند، بنابراین نتیجه این API نباید برای مدت طولانی در حافظه پنهان یا ذخیره شود. برای ایمن بودن نسبی بیش از یک روز را در نظر نگیرید.

SearchLatestFloodStatusByArea

rpc SearchLatestFloodStatusByArea( SearchLatestFloodStatusByAreaRequest ) returns ( SearchLatestFloodStatusByAreaResponse )

آخرین وضعیت سیل را بر اساس منطقه جغرافیایی جستجو کنید. توجه: وضعیت‌های سیل را برمی‌گرداند که گیج آن‌ها در منطقه داده‌شده باشد، به‌عنوان مثال، در تقاطع منطقه آسیب‌دیده با منطقه معین. این موضوع در آینده قابل تغییر است.

BatchGetGaugeModelsRequest

درخواست BatchGetGaugeModels.

فیلدها
names[]

string

مورد نیاز. نام های مدل سنج برای بازیابی. قالب نام: gaugeModels/{gauge_id}. اندازه لیست پشتیبانی شده به 20000 محدود است. اگر لیستی بزرگتر از 20000 ارائه شود، با خطای INVALID_REQUEST ناموفق است.

BatchGetGaugeModelsResponse

پاسخ BatchGetGaugeModels.

فیلدها
gauge_models[]

GaugeModel

مدل های گیج درخواستی

BatchGetGaugesRequest

درخواست BatchGetGauges.

فیلدها
names[]

string

مورد نیاز. نام سنج برای بازیابی. قالب نام: gauges/{gauge_id}. اندازه لیست پشتیبانی شده به 100000 محدود است. اگر لیستی بزرگتر از 100000 ارائه شود، با خطای INVALID_REQUEST ناموفق است.

BatchGetGaugesResponse

پاسخ BatchGetGauges.

فیلدها
gauges[]

Gauge

سنج های درخواستی

وضعیت سیل

وضعیت سیل صادر شده توسط سیستم. وضعیت سیل پیش بینی شده توسط سیستم برای یک منطقه را با ویژگی هایی مانند شدت، تغییر پیش بینی، نقشه های سیلاب و موارد دیگر نشان می دهد. برای جزئیات بیشتر به زیر مراجعه کنید.

فیلدها
gauge_id

string

شناسه سنج این وضعیت برای آن صادر شده است.

quality_verified

bool

درست است اگر گیجی که این وضعیت سیل برای آن صادر شده مدل نداشته باشد یا مدل داشته باشد و مدل از نظر کیفیت تأیید شده باشد. لطفاً وقتی این مقدار روی false تنظیم شده است با احتیاط استفاده کنید.

gauge_location

LatLng

محل سنج این وضعیت برای آن صادر شده است.

issued_time

string

زمانی که این وضعیت به عنوان رشته (ISO 8601) صادر شد، به عنوان مثال، "2023-06-17T10:34:00Z".

forecast_time_range

TimeRange

محدوده زمانی که پیش بینی برای آن پیش بینی می کند.

forecast_change

ForecastChange

مقدار پیش بینی از آخرین وضعیت شناخته شده به پیش بینی تغییر می کند. در حال حاضر فقط برای مدل های سطح آب موجود است.

forecast_trend

ForecastTrend

روند پیش بینی.

map_inference_type

MapInferenceType

نوع استنتاج این نقشه توسط آن ایجاد شده است.

severity

Severity

شدت وضعیت.

inundation_map_set

InundationMapSet

مجموعه نقشه طغیان استنباط شده

source

string

سازمان مسئول داده های این سنج، به عنوان مثال، GRDC، CWC، و غیره.

serialized_notification_polygon_id

string

شناسه ای از چند ضلعی اعلان سریالی که نشان دهنده منطقه جغرافیایی است که Google برای تعیین زمان هشدار به کاربرانش استفاده می کند. از GetSerializedPolygon برای بدست آوردن خود چند ضلعی سریالی استفاده کنید.

ForecastChange

مقدار پیش بینی شده از آخرین وضعیت شناخته شده به پیش بینی تغییر می کند. در حال حاضر فقط برای مدل های سطح آب موجود است.

فیلدها
value_change

ValueChange

تغییر پیش بینی شده در مقادیر

reference_time_range

TimeRange

محدوده زمانی آخرین وضعیت شناخته شده، که از آن تغییر مقدار را پیش بینی می کنیم. به عنوان مثال، ممکن است محدوده زمانی مرجع را روی دیروز تنظیم کنیم و مقدار آن بین 25 تا 30 سانتی متر تغییر کند. این بدان معناست که افزایش 25 تا 30 سانتی متری سطح آب با مقدار دیروز آن مقایسه می شود، نه با مقدار فعلی آن.

تغییر ارزش

تغییر پیش بینی شده در مقادیر - یک کران بالا و پایین.

فیلدها
lower_bound

double

حد پایین تغییر پیش بینی بر حسب متر. اگر تغییر بین 20 و 30 باشد، این مقدار 20 خواهد بود. اگر تغییر بین 30- و 20- باشد، این مقدار 30- خواهد بود.

upper_bound

double

کران بالای تغییر پیش بینی بر حسب متر. اگر تغییر بین 20 و 30 باشد، این مقدار 30 خواهد بود. اگر تغییر بین 30- و 20- باشد، این مقدار 20- خواهد بود.

ForecastTrend

یک عدد که نشان دهنده روند پیش بینی است.

Enums
FORECAST_TREND_UNSPECIFIED مقدار پیش فرض این مقدار استفاده نشده است.
RISE این نشان دهنده افزایش ارزش پیش بینی شده است.
FALL این نشان دهنده کاهش ارزش پیش بینی شده است.
NO_CHANGE این نشان دهنده عدم تغییر در مقدار پیش بینی شده است.

Inundation Map

یک نقشه طغیان

فیلدها
level

InundationLevel

سطح نقشه طغیان - مستندات را بر اساس InundationMapType ببینید.

serialized_polygon_id

string

شناسه چند ضلعی سریالی که این نقشه خطر طغیان را نشان می دهد. از GetSerializedPolygon برای بدست آوردن خود چند ضلعی سریالی استفاده کنید.

InundationLevel

یک عدد که سطوح طغیان را نشان می دهد.

Enums
INUNDATION_LEVEL_UNSPECIFIED مقدار پیش فرض این مقدار استفاده نشده است.
HIGH مستندات مبتنی بر InundationMapType را ببینید.
MEDIUM مستندات مبتنی بر InundationMapType را ببینید.
LOW مستندات مبتنی بر InundationMapType را ببینید.

InundationMapSet

مجموعه ای از نقشه های سیل.

فیلدها
inundation_maps[]

InundationMap

نقشه های سیلاب، یکی برای هر سطح آبگرفتگی.

inundation_maps_time_range

TimeRange

محدوده زمانی حالتی که نقشه های سیلاب به آن اشاره دارد.

inundation_map_type

InundationMapType

نوع نقشه طغیان

InundationMapType

یک عدد که نشان دهنده نوع نقشه طغیان است.

Enums
INUNDATION_MAP_TYPE_UNSPECIFIED مقدار پیش فرض این مقدار استفاده نشده است.
PROBABILITY نقشه احتمال نوع InundationLevel نشان دهنده احتمال نقشه - احتمال زیاد/متوسط/کم سیل است. چند ضلعی با احتمال زیاد در چند ضلعی احتمال متوسط ​​و چند ضلعی با احتمال متوسط ​​در چند ضلعی با احتمال کم قرار دارد.
DEPTH یک نقشه از نوع عمق. InundationLevel نشان دهنده عمق نقشه - عمق زیاد/متوسط/کم در هر مکان است. چند ضلعی با عمق زیاد در چند ضلعی عمق متوسط ​​و چند ضلعی عمق متوسط ​​در چند ضلعی عمق کم قرار دارد.

MapInferenceType

enum که نشان دهنده انواع استنتاج های نقشه است.

Enums
MAP_INFERENCE_TYPE_UNSPECIFIED مقدار پیش فرض این مقدار استفاده نشده است.
MODEL این نشان می دهد که این استنتاج با استفاده از یک مدل ایجاد شده است.
IMAGE_CLASSIFICATION این نشان می دهد که این استنتاج با استفاده از طبقه بندی تصویر ایجاد شده است.

شدت

یک عدد که نشان دهنده شدت وضعیت است.

Enums
SEVERITY_UNSPECIFIED مقدار پیش فرض این مقدار استفاده نشده است.
EXTREME این نشان دهنده وضعیت شدید پیش بینی شده است.
SEVERE این نشان دهنده وضعیت شدید پیش بینی شده است.
ABOVE_NORMAL این نشان دهنده وضعیت پیش بینی شده بالاتر از حد نرمال است.
NO_FLOODING این نشان دهنده پیش بینی عدم وقوع سیل است.
UNKNOWN این نشان می دهد که ما اطلاعات کافی برای تعیین شدت نداریم.

پیش بینی

پیش‌بینی یک گیج برای چندین بار پیش‌بینی. برای مثال، یک پیش‌بینی می‌تواند ساعت 5 بعدازظهر باشد و شامل پیش‌بینی‌های 6 بعدازظهر، 7 بعد از ظهر، 8 بعد از ظهر و غیره باشد.

توجه: برخی از محدوده های پیش بینی به طور بالقوه می توانند زودتر از زمان صادر شده باشند. این می تواند به دلیل تاخیر در داده های ورودی مدل اتفاق بیفتد. با مثال بالا، ممکن است زمان صدور 5 بعدازظهر باشد و محدوده پیش بینی برای 16، 17، 18 و غیره باشد.

توجه: دامنه ها از نظر طول و فاصله بین آنها متفاوت است. چند نمونه از محدوده های ممکن عبارتند از:

  1. [5 بعدازظهر - 5 بعد از ظهر]، [6 بعد از ظهر تا 6 بعد از ظهر]، [7 بعد از ظهر تا 7 بعد از ظهر]

  2. [1 مارس 12 صبح - 2 مارس 12 صبح]، [2 مارس 12 صبح - 3 مارس 12 صبح]، [3 مارس، 12 صبح - 4 مارس، 12 صبح]

فیلدها
forecast_ranges[]

ForecastTimedValue

یک پیش‌بینی شامل چندین «محدوده پیش‌بینی» است، که مقادیر پیش‌بینی متفاوت مربوط به بازه‌های زمانی مختلف هستند. وقتی شروع و پایان یک محدوده با هم برابر باشد، به این معنی است که یک لحظه زمانی است.

gauge_id

string

شناسه سنج این پیش بینی برای آن است.

issued_time

string

زمان صدور پیش‌بینی (ISO 8601)، به عنوان مثال «2023-06-17T10:34:00Z». زمان صادر شده زمانی است که پیش بینی ایجاد شده است.

ForecastSet

مجموعه ای از پیش بینی ها برای یک سنج.

فیلدها
forecasts[]

Forecast

پیش بینی ها

ForecastTimedValue

یک مقدار پیش بینی مربوط به یک محدوده زمانی. واحدهای آن توسط GaugeModel که با آن مرتبط است تعریف می شوند. اگر شروع و پایان برابر باشند، به این معنی است که یک لحظه است.

فیلدها
value

double

ارزش پیش بینی

forecast_start_time

string

شروع فاصله.

forecast_end_time

string

پایان فاصله.

سنج

فراداده یک سنج.

فیلدها
location

LatLng

موقعیت فیزیکی سنج.

site_name

string

نام سایتی که این سنج در آن قرار دارد، به زبان انگلیسی. این یک شناسه منحصر به فرد نیست. ممکن است چندین سنج در مکان های نزدیک با همان نام سایت وجود داشته باشد. همیشه حاضر نیست.

source

string

سازمان مسئول داده های این سنج، به عنوان مثال GRDC، CWC، و غیره.

river

string

نام رودخانه سنج به انگلیسی. همیشه حاضر نیست.

country_code

string

کد کشور کشور سنج (ISO 3166 Alpha-2).

gauge_id

string

شناسه سنج.

quality_verified

bool

اگر گیج مدل نداشته باشد یا مدل داشته باشد و مدل از نظر کیفیت تأیید شده باشد، این قسمت درست است. لطفاً وقتی این مقدار روی false تنظیم شده است با احتیاط استفاده کنید.

has_model

bool

اگر گیج مدل داشته باشد این فیلد درست است. اگر گیج دارای مدل باشد، می‌توان GaugeModel این سنج را با استفاده از GetGaugeModel یا BatchGetGaugeModels دریافت کرد. و همچنین پیش بینی های آن را با استفاده از QueryGaugeForecasts دریافت کنید.

GaugeModel

فراداده مدل سنج.

فیلدها
gauge_id

string

شناسه سنج.

gauge_model_id

string

شناسه مدل گیج. هر از گاهی، مدل گیج ممکن است تغییر کند، و در آن صورت، یک شناسه جدید و آستانه‌های جدید به مدل جدید اختصاص می‌دهیم. لطفاً هنگام مقایسه پیش‌بینی‌های قدیمی با پیش‌بینی‌های جدید، در صورتی که توسط مدل‌های مختلف تولید شده‌اند، احتیاط کنید.

thresholds

Thresholds

آستانه های سنج.

gauge_value_unit

GaugeValueUnit

واحد ارزش مدل سنج.

quality_verified

bool

اینکه آیا این مدل کیفیت تایید شده است یا خیر. لطفاً وقتی این مقدار روی false تنظیم شده است با احتیاط استفاده کنید.

GaugeValueUnit

واحدهای ارزش سنج احتمالی

Enums
GAUGE_VALUE_UNIT_UNSPECIFIED مقدار پیش فرض این مقدار استفاده نشده است.
METERS متر.
CUBIC_METERS_PER_SECOND متر مکعب در ثانیه.

GetGaugeModelRequest

درخواست GetGaugeModel.

فیلدها
name

string

مورد نیاز. نام مدل سنج برای بازیابی. قالب نام: gaugeModels/{gauge_id}.

GetGaugeRequest

درخواست GetGauge.

فیلدها
name

string

مورد نیاز. نام گیج برای بازیابی. قالب نام: gauges/{gauge_id}.

GetSerializedPolygonRequest

درخواست GetSerializedPolygon.

فیلدها
name

string

مورد نیاز. نام چند ضلعی سریال شده برای بازیابی. قالب نام: serializedPolygons/{polygon_id}

حلقه

یک حلقه روی نقشه یک چندضلعی کروی ساده را نشان می دهد. این شامل یک زنجیره واحد از رئوس است که در آن راس اول به طور ضمنی به آخرین راس متصل است.

فیلدها
vertices[]

LatLng

مورد نیاز. رئوس حلقه.

QueryGaugeForecastsRequest

درخواست QueryGaugeForcasts.

فیلدها
gauge_ids[]

string

مورد نیاز. لیستی از شناسه های سنج. اندازه لیست پشتیبانی شده به 500 محدود شده است. اگر لیستی بزرگتر از 500 ارائه شود، با خطای INVALID_REQUEST ناموفق است.

issued_time_start

string

اختیاری. اولین پیش‌بینی زمان صادر شده به‌عنوان رشته (ISO 8601)، به‌عنوان مثال «2023-06-17T10:34:00Z» یا یک رشته تاریخ مانند «2023-10-13». زمان شروع نمی تواند زودتر از "01-10-2023" باشد. پیش فرض یک هفته پیش است.

issued_time_end

string

اختیاری. آخرین پیش‌بینی زمان صادر شده به‌عنوان رشته (ISO 8601)، به‌عنوان مثال «2023-06-17T10:34:00Z» یا یک رشته تاریخ مانند «2023-10-13». پیش فرض اکنون است.

QueryGaugeForecastsResponse

پاسخ QueryGaugeForcasts.

فیلدها
forecasts

map<string, ForecastSet >

نقشه ای از شناسه سنج تا مجموعه پیش بینی.

QueryLatestFloodStatusByGaugeIdsRequest

درخواست QueryLatestFloodStatusByGaugeIds.

فیلدها
gauge_ids[]

string

مورد نیاز. لیستی از شناسه های سنج. اندازه لیست پشتیبانی شده به 20000 محدود است. اگر لیستی بزرگتر از 20000 ارائه شود، با خطای INVALID_REQUEST ناموفق است.

QueryLatestFloodStatusByGaugeIdsResponse

پاسخ QueryLatestFloodStatusByGaugeIds.

فیلدها
flood_statuses[]

FloodStatus

آخرین وضعیت سیلاب برای سنج های درخواستی.

SearchGaugesByAreaRequest

درخواست SearchGaugesByArea.

فیلدها
page_size

int32

اختیاری. حداکثر تعداد سنج برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند. اگر نامشخص باشد، حداکثر 50000 گیج برگردانده می شود. حداکثر مقدار 50000 است. مقادیر بالای 50000 به 50000 اجباری می شود.

page_token

string

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی SearchGauges . این را برای بازیابی صفحه بعدی ارائه کنید. هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به SearchGauges باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.

search_by فیلد اتحادیه توسط .

search_by می تواند تنها یکی از موارد زیر باشد:

region_code

string

همه گیج های یک منطقه را بر اساس کد منطقه جستجو کنید. از https://cldr.unicode.org/ (لیست https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) استفاده کنید.

loop

Loop

همه گیج ها را در یک حلقه جستجو کنید (یک چندضلعی کروی ساده، به Loop مراجعه کنید).

include_non_quality_verified

bool

اختیاری. اندازه‌گیری‌هایی را که کیفیت تأیید نشده‌اند در نتایج وارد کنید. لطفا با احتیاط استفاده کنید پیش فرض نادرست است.

include_gauges_without_hydro_model

bool

اختیاری. اندازه‌گیری‌هایی را در نتایج بگنجانید که مدل آبی داخلی Google ندارند. پیش فرض نادرست است.

SearchGaugesByAreaResponse

پاسخ SearchGaugesByArea.

فیلدها
gauges[]

Gauge

سنج هایی که در منطقه درخواستی یافت می شوند.

next_page_token

string

اختیاری. نشانه ای که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد.

SearchLatestFloodStatusByAreaRequest

درخواست SearchLatestFloodStatusByArea.

فیلدها
page_token

string

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی SearchLatestFloodStatusByArea . این را برای بازیابی صفحه بعدی ارائه کنید. هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به SearchLatestFloodStatusByArea باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.

page_size

int32

اختیاری. حداکثر تعداد وضعیت سیل برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند. اگر نامشخص باشد، حداکثر 20000 وضعیت سیل برگشت داده می شود. حداکثر مقدار 20000 است. مقادیر بالای 20000 به 20000 اجباری می شود.

area_type فیلد اتحادیه.

area_type تنها می تواند یکی از موارد زیر باشد:

region_code

string

منطقه ای که از طریق آن وضعیت سیل را جویا می شود. با استفاده از CLDR، به عنوان مثال، "US".

loop

Loop

حلقه ای که با آن وضعیت سیل را پرس و جو می کند.

include_non_quality_verified

bool

اختیاری. اندازه‌گیری‌هایی را که کیفیت تأیید نشده‌اند در نتایج وارد کنید. لطفا با احتیاط استفاده کنید پیش فرض نادرست است.

SearchLatestFloodStatusByAreaResponse

پاسخ SearchLatestFloodStatusByArea.

فیلدها
flood_statuses[]

FloodStatus

آخرین وضعیت سیل در منطقه درخواستی در حال حاضر، این با توجه به محل گیج ها تعیین می شود، این در آینده ممکن است تغییر کند.

next_page_token

string

اختیاری. نشانه ای که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد.

چند ضلعی سریالی شده

یک چند ضلعی سریالی

فیلدها
polygon_id

string

شناسه چند ضلعی.

kml

string

نمایش رشته KML از چند ضلعی.

آستانه ها

آستانه های مدل سنج.

فیلدها
warning_level

double

سطح هشدار

danger_level

double

سطح خطر

extreme_danger_level

double

سطح خطر شدید همیشه حاضر نیست.

محدوده زمانی

یک محدوده زمانی

فیلدها
start

string

شروع محدوده زمانی. به عنوان ISO 8601 نشان داده شده است، به عنوان مثال، "2023-06-17T10:34:00Z".

end

string

پایان محدوده زمانی. به عنوان ISO 8601 نشان داده شده است، به عنوان مثال، "2023-06-17T10:34:00Z".