Package google.research.floodforecasting.v1

Chỉ mục

FloodsApi

Một dịch vụ API bên ngoài để Dự báo lũ lụt.

BatchGetGaugeModels

rpc BatchGetGaugeModels(BatchGetGaugeModelsRequest) returns (BatchGetGaugeModelsResponse)

Nhận siêu dữ liệu mô hình thuỷ văn hiện tại cho nhiều thiết bị đo.
BatchGetGauges

rpc BatchGetGauges(BatchGetGaugesRequest) returns (BatchGetGaugesResponse)

Lấy siêu dữ liệu về nhiều đồng hồ đo.
GetGauge

rpc GetGauge(GetGaugeRequest) returns (Gauge)

Lấy siêu dữ liệu về một đồng hồ đo.
GetGaugeModel

rpc GetGaugeModel(GetGaugeModelRequest) returns (GaugeModel)

Nhận siêu dữ liệu mô hình thuỷ văn hiện tại cho một thiết bị đo cụ thể.
GetSerializedPolygon

rpc GetSerializedPolygon(GetSerializedPolygonRequest) returns (SerializedPolygon)

Lấy một đa giác được chuyển đổi thành chuỗi. Mã nhận dạng cho các đối tượng này sẽ xuất hiện trong các Phản hồi API khác và bạn có thể sử dụng các mã nhận dạng này tại đây. Ví dụ: xem InundationMap trong FloodStatus.
QueryGaugeForecasts

rpc QueryGaugeForecasts(QueryGaugeForecastsRequest) returns (QueryGaugeForecastsResponse)

Thông tin dự đoán về chỉ số truy vấn.
QueryLatestFloodStatusByGaugeIds

rpc QueryLatestFloodStatusByGaugeIds(QueryLatestFloodStatusByGaugeIdsRequest) returns (QueryLatestFloodStatusByGaugeIdsResponse)

Truy vấn trạng thái lũ lụt mới nhất theo mã nhận dạng của thiết bị đo.
SearchGaugesByArea

rpc SearchGaugesByArea(SearchGaugesByAreaRequest) returns (SearchGaugesByAreaResponse)

Tìm kiếm các đồng hồ đo theo khu vực địa lý.

Lưu ý: Đôi khi, các chỉ số sẽ được thêm hoặc xoá, vì vậy, bạn không nên lưu vào bộ nhớ đệm hoặc lưu trữ kết quả của API này trong thời gian dài. Hãy cân nhắc việc không quá một ngày để tương đối an toàn.
SearchLatestFloodStatusByArea

rpc SearchLatestFloodStatusByArea(SearchLatestFloodStatusByAreaRequest) returns (SearchLatestFloodStatusByAreaResponse)

Tìm kiếm trạng thái ngập lụt mới nhất theo khu vực địa lý. Lưu ý: Trả về trạng thái lũ có đồng hồ đo nằm trong khu vực đã cho, thay vì ví dụ: khu vực bị ảnh hưởng giao với khu vực đã cho. Nội dung này có thể thay đổi trong tương lai.

BatchGetGaugeModelsRequest

Yêu cầu của BatchGetGaugeModels.

Trường
names[]

string

Bắt buộc. Tên mẫu đồng hồ đo cần truy xuất. Định dạng tên: gaugeModels/{gauge_id}. Danh sách được hỗ trợ có kích thước tối đa là 20.000. Nếu bạn cung cấp một danh sách lớn hơn 20.000,thì danh sách đó sẽ không thành công và gặp lỗi INVALID_REQUEST.

BatchGetGaugeModelsResponse

Phản hồi của BatchGetGaugeModels.

Trường
gauge_models[]

GaugeModel

Các mô hình đồng hồ đo được yêu cầu.

BatchGetGaugesRequest

Yêu cầu của BatchGetGauges.

Trường
names[]

string

Bắt buộc. Tên của các chỉ số cần truy xuất. Định dạng tên: gauges/{gauge_id}. Kích thước danh sách được hỗ trợ tối đa là 100.000. Nếu bạn cung cấp một danh sách lớn hơn 100.000,thì danh sách đó sẽ không thành công và gặp lỗi INVALID_REQUEST.

BatchGetGaugesResponse

Phản hồi của BatchGetGauges.

Trường
gauges[]

Gauge

Các đồng hồ đo được yêu cầu.

FloodStatus

Trạng thái lũ lụt do hệ thống đưa ra. Biểu thị trạng thái lũ lụt mà hệ thống dự báo cho một khu vực, với các thuộc tính như mức độ nghiêm trọng, thay đổi dự báo, bản đồ ngập lụt và các thuộc tính khác. Hãy xem mục bên dưới để biết thêm thông tin.

Trường
gauge_id

string

Mã nhận dạng của đồng hồ đo mà trạng thái này được cấp.
quality_verified

bool

Đúng nếu đồng hồ đo mà trạng thái ngập lụt này được đưa ra không có mô hình, hoặc nếu có mô hình và mô hình đó đã được xác minh chất lượng. Hãy thận trọng khi sử dụng nếu bạn đặt giá trị này thành false.
gauge_location

LatLng

Vị trí của đồng hồ đo mà trạng thái này được cấp.
issued_time

string

Thời gian trạng thái này được phát hành dưới dạng chuỗi (ISO 8601), ví dụ: "2023-06-17T10:34:00Z".
forecast_time_range

TimeRange

Phạm vi thời gian mà thông tin dự đoán đang dự đoán.
forecast_change

ForecastChange

Giá trị dự đoán thay đổi từ trạng thái đã biết gần đây nhất sang trạng thái dự đoán. Hiện chỉ có sẵn cho các mô hình Mực nước.
forecast_trend

ForecastTrend

Xu hướng của dự báo.
map_inference_type

MapInferenceType

Loại suy luận mà bản đồ này được tạo ra.
severity

Severity

Mức độ nghiêm trọng của trạng thái.
inundation_map_set

InundationMapSet

Tập hợp bản đồ dự báo ngập lụt được suy luận.
source

string

Tổ chức chịu trách nhiệm về dữ liệu của chỉ số này, ví dụ: GRDC, CWC, v.v.
serialized_notification_polygon_id

string

Mã nhận dạng của đa giác thông báo được chuyển đổi tuần tự, đại diện cho khu vực địa lý mà Google sử dụng để xác định thời điểm cảnh báo người dùng. Sử dụng GetSerializedPolygon để lấy chính đa giác được chuyển đổi tuần tự.

ForecastChange

Mức thay đổi giá trị dự đoán so với trạng thái đã biết gần đây nhất. Hiện chỉ có sẵn cho các mô hình Mực nước.

Trường
value_change

ValueChange

Mức thay đổi dự đoán về giá trị.
reference_time_range

TimeRange

Phạm vi thời gian của trạng thái đã biết gần đây nhất, từ đó chúng tôi dự đoán sự thay đổi về giá trị. Ví dụ: chúng ta có thể đặt phạm vi thời gian tham chiếu là ngày hôm qua và mức thay đổi giá trị là 25 – 30 cm. Điều này có nghĩa là mức tăng mực nước từ 25 đến 30 cm được so sánh với giá trị của ngày hôm qua, chứ không phải giá trị hiện tại.

ValueChange

Mức thay đổi dự kiến về giá trị – cận trên và cận dưới.

Trường
lower_bound

double

Giới hạn dưới của mức thay đổi dự báo tính bằng mét. Nếu mức thay đổi nằm trong khoảng từ 20 đến 30, thì giá trị này sẽ là 20. Nếu mức thay đổi nằm trong khoảng từ -30 đến -20, thì giá trị này sẽ là -30.
upper_bound

double

Giới hạn trên của mức thay đổi dự báo tính bằng mét. Nếu mức thay đổi nằm trong khoảng từ 20 đến 30, thì giá trị này sẽ là 30. Nếu mức thay đổi nằm trong khoảng từ -30 đến -20, thì giá trị này sẽ là -20.

ForecastTrend

Một enum đại diện cho xu hướng của dự báo.

Enum
FORECAST_TREND_UNSPECIFIED Giá trị mặc định. Giá trị này không được dùng.
RISE Điều này cho thấy giá trị dự đoán tăng lên.
FALL Điều này cho thấy giá trị dự đoán giảm.
NO_CHANGE Điều này cho biết không có thay đổi nào về giá trị dự đoán.

InundationMap

Một bản đồ về tình trạng ngập lụt.

Trường
level

InundationLevel

Mức độ của bản đồ ngập lụt – Xem tài liệu dựa trên InundationMapType.
serialized_polygon_id

string

Mã nhận dạng của đa giác được chuyển đổi tuần tự, đại diện cho bản đồ nguy cơ ngập lụt này. Sử dụng GetSerializedPolygon để lấy chính đa giác được chuyển đổi tuần tự.

InundationLevel

Một enum đại diện cho các mức ngập lụt.

Enum
INUNDATION_LEVEL_UNSPECIFIED Giá trị mặc định. Giá trị này không được dùng.
HIGH Xem tài liệu dựa trên InundationMapType.
MEDIUM Xem tài liệu dựa trên InundationMapType.
LOW Xem tài liệu dựa trên InundationMapType.

InundationMapSet

Một bộ bản đồ ngập lụt.

Trường
inundation_maps[]

InundationMap

Bản đồ về tình trạng ngập lụt, mỗi bản đồ cho một mức ngập lụt.
inundation_maps_time_range

TimeRange

Phạm vi thời gian của trạng thái mà bản đồ ngập lụt đề cập đến.
inundation_map_type

InundationMapType

Loại bản đồ về tình trạng ngập lụt.

InundationMapType

Một enum đại diện cho loại bản đồ ngập lụt.

Enum
INUNDATION_MAP_TYPE_UNSPECIFIED Giá trị mặc định. Giá trị này không được dùng.
PROBABILITY Bản đồ xác suất loại. InundationLevel biểu thị xác suất trên bản đồ – xác suất ngập lụt cao/trung bình/thấp. Đa giác có xác suất cao nằm trong đa giác có xác suất trung bình và đa giác có xác suất trung bình nằm trong đa giác có xác suất thấp.
DEPTH Bản đồ độ sâu kiểu chữ. InundationLevel biểu thị độ sâu của bản đồ – độ sâu cao/trung bình/thấp cho mỗi vị trí. Đa giác có độ sâu cao nằm trong đa giác có độ sâu trung bình và đa giác có độ sâu trung bình nằm trong đa giác có độ sâu thấp.

MapInferenceType

Một enum đại diện cho các loại suy luận trên bản đồ.

Enum
MAP_INFERENCE_TYPE_UNSPECIFIED Giá trị mặc định. Giá trị này không được dùng.
MODEL Điều này cho thấy suy luận này được tạo bằng một mô hình.
IMAGE_CLASSIFICATION Điều này cho thấy suy luận này được tạo bằng tính năng phân loại hình ảnh.

Mức độ nghiêm trọng

Một enum đại diện cho mức độ nghiêm trọng của trạng thái.

Enum
SEVERITY_UNSPECIFIED Giá trị mặc định. Giá trị này không được dùng.
EXTREME Điều này cho biết trạng thái cực đoan được dự báo.
SEVERE Điều này cho biết trạng thái nghiêm trọng theo dự báo.
ABOVE_NORMAL Điều này cho biết trạng thái dự báo là cao hơn bình thường.
NO_FLOODING Điều này cho biết dự báo không có lũ.
UNKNOWN Điều này cho biết chúng tôi không có đủ thông tin để xác định mức độ nghiêm trọng.

Dự báo

Thông tin dự báo của một đồng hồ đo cho nhiều khoảng thời gian dự báo. Ví dụ: một bản dự báo có thể có thời gian phát hành là 5 giờ chiều và bao gồm dự báo cho 6 giờ chiều, 7 giờ chiều, 8 giờ chiều, v.v.

Lưu ý: Một số phạm vi dự báo có thể sớm hơn thời gian phát hành. Điều này có thể xảy ra do ví dụ: dữ liệu đầu vào cho mô hình bị trễ. Với ví dụ trên, có thể thời gian xảy ra vấn đề là 5 giờ chiều và phạm vi dự đoán là 4 giờ chiều, 5 giờ chiều, 6 giờ chiều, v.v.

Lưu ý: Các dải có độ dài và khoảng cách khác nhau. Sau đây là một số ví dụ về các phạm vi có thể có:

  1. [17:00 – 17:00], [18:00 – 18:00], [19:00 – 19:00]

  2. [00:00 ngày 1 tháng 3 – 00:00 ngày 2 tháng 3], [00:00 ngày 2 tháng 3 – 00:00 ngày 3 tháng 3], [00:00 ngày 3 tháng 3 – 00:00 ngày 4 tháng 3]

Trường
forecast_ranges[]

ForecastTimedValue

Thông tin dự báo bao gồm một số "phạm vi dự báo", là các giá trị dự báo khác nhau liên quan đến các phạm vi thời gian khác nhau. Khi điểm bắt đầu và điểm kết thúc của một phạm vi bằng nhau, tức là đó là một thời điểm.
gauge_id

string

Mã nhận dạng của đồng hồ đo mà dự báo này dành cho.
issued_time

string

Thời gian phát hành dự báo (ISO 8601), ví dụ: "2023-06-17T10:34:00Z". Thời gian phát hành là thời gian tạo thông tin dự báo.

ForecastSet

Một tập hợp các dự báo cho một chỉ số.

Trường
forecasts[]

Forecast

Thông tin dự báo.

ForecastTimedValue

Giá trị dự đoán liên quan đến một khoảng thời gian. Các đơn vị của chỉ số này được xác định bằng GaugeModel mà chỉ số đó được liên kết. Nếu thời gian bắt đầu và kết thúc bằng nhau, tức là đó là một thời điểm.

Trường
value

double

Giá trị của thông tin dự đoán.
forecast_start_time

string

Điểm bắt đầu của khoảng thời gian.
forecast_end_time

string

Kết thúc khoảng thời gian.

Biểu đồ dạng đồng hồ đo

Siêu dữ liệu của một đồng hồ đo.

Trường
location

LatLng

Vị trí thực tế của đồng hồ đo.
site_name

string

Tên của địa điểm đặt đồng hồ đo này, bằng tiếng Anh. Đây không phải là giá trị nhận dạng duy nhất; có thể có nhiều đồng hồ đo ở các vị trí lân cận có cùng tên địa điểm. Không phải lúc nào cũng có.
source

string

Tổ chức chịu trách nhiệm về dữ liệu của đồng hồ đo này, ví dụ: GRDC, CWC, v.v.
river

string

Tên sông của trạm đo bằng tiếng Anh. Không phải lúc nào cũng có.
country_code

string

Mã quốc gia của quốc gia có đồng hồ đo (ISO 3166 Alpha-2).
gauge_id

string

Mã nhận dạng của đồng hồ đo.
quality_verified

bool

Trường này là true nếu đồng hồ đo không có mô hình hoặc nếu đồng hồ đo có mô hình và mô hình đó đã được xác minh chất lượng. Hãy thận trọng khi sử dụng nếu bạn đặt giá trị này thành false.
has_model

bool

Trường này là true nếu đồng hồ đo có một mô hình. Nếu đồng hồ đo có một mô hình, bạn có thể lấy GaugeModel của đồng hồ đo này bằng cách sử dụng GetGaugeModel hoặc BatchGetGaugeModels. Đồng thời, bạn cũng có thể nhận thông tin dự đoán về nhu cầu bằng cách sử dụng QueryGaugeForecasts.

GaugeModel

Siêu dữ liệu của mô hình đồng hồ đo.

Trường
gauge_id

string

Mã nhận dạng của đồng hồ đo.
gauge_model_id

string

Mã nhận dạng của kiểu đồng hồ đo. Đôi khi, mô hình cho một đồng hồ đo có thể thay đổi. Trong trường hợp đó, chúng tôi sẽ chỉ định một mã nhận dạng mới và các ngưỡng mới cho mô hình mới. Vui lòng thận trọng khi so sánh thông tin dự đoán cũ với thông tin dự đoán mới nếu chúng được tạo bằng các mô hình khác nhau.
thresholds

Thresholds

Ngưỡng của thiết bị đo mực nước.
gauge_value_unit

GaugeValueUnit

Đơn vị giá trị của mô hình đồng hồ đo.
quality_verified

bool

Liệu mô hình này có được xác minh chất lượng hay không. Hãy thận trọng khi sử dụng nếu bạn đặt giá trị này thành false.

GaugeValueUnit

Các đơn vị giá trị có thể có của đồng hồ đo.

Enum
GAUGE_VALUE_UNIT_UNSPECIFIED Giá trị mặc định. Giá trị này không được dùng.
METERS Mét.
CUBIC_METERS_PER_SECOND Mét khối trên giây.

GetGaugeModelRequest

Yêu cầu GetGaugeModel.

Trường
name

string

Bắt buộc. Tên mẫu đồng hồ đo cần truy xuất. Định dạng tên: gaugeModels/{gauge_id}.

GetGaugeRequest

Yêu cầu của GetGauge.

Trường
name

string

Bắt buộc. Tên của đồng hồ đo cần truy xuất. Định dạng tên: gauges/{gauge_id}.

GetSerializedPolygonRequest

Yêu cầu của GetSerializedPolygon.

Trường
name

string

Bắt buộc. Tên của đa giác được chuyển đổi tuần tự cần truy xuất. Định dạng tên: serializedPolygons/{polygon_id}

Lặp

Một vòng lặp trên bản đồ. Biểu thị một đa giác hình cầu đơn giản. Đường này bao gồm một chuỗi đỉnh duy nhất, trong đó đỉnh đầu tiên được kết nối ngầm với đỉnh cuối cùng.

Trường
vertices[]

LatLng

Bắt buộc. Các đỉnh của vòng lặp.

QueryGaugeForecastsRequest

Yêu cầu của QueryGaugeForecasts.

Trường
gauge_ids[]

string

Bắt buộc. Danh sách mã nhận dạng đồng hồ đo. Danh sách được hỗ trợ có tối đa 500 mục. Nếu bạn cung cấp một danh sách có hơn 500 mục, thì yêu cầu sẽ không thành công và trả về lỗi INVALID_REQUEST.
issued_time_start

string

Không bắt buộc. Thời gian phát hành dự báo sớm nhất dưới dạng chuỗi (ISO 8601), ví dụ: "2023-06-17T10:34:00Z" hoặc chuỗi ngày, ví dụ: "2023-10-13". Thời gian bắt đầu không được sớm hơn "2023-10-01". Giá trị mặc định là một tuần trước.
issued_time_end

string

Không bắt buộc. Thời gian phát hành dự báo mới nhất dưới dạng chuỗi (ISO 8601), ví dụ: "2023-06-17T10:34:00Z" hoặc chuỗi ngày, ví dụ: "2023-10-13". Giá trị mặc định là now.

QueryGaugeForecastsResponse

Phản hồi của QueryGaugeForecasts.

Trường
forecasts

map<string, ForecastSet>

Bản đồ từ mã nhận dạng đồng hồ đo đến tập hợp dự báo.

QueryLatestFloodStatusByGaugeIdsRequest

Yêu cầu của QueryLatestFloodStatusByGaugeIds.

Trường
gauge_ids[]

string

Bắt buộc. Danh sách mã nhận dạng đồng hồ đo. Danh sách được hỗ trợ có kích thước tối đa là 20.000. Nếu bạn cung cấp một danh sách lớn hơn 20.000,thì danh sách đó sẽ không thành công và gặp lỗi INVALID_REQUEST.

QueryLatestFloodStatusByGaugeIdsResponse

Phản hồi của QueryLatestFloodStatusByGaugeIds.

Trường
flood_statuses[]

FloodStatus

Trạng thái lũ lụt mới nhất của các trạm đo được yêu cầu.

SearchGaugesByAreaRequest

Yêu cầu của SearchGaugesByArea.

Trường
page_size

int32

Không bắt buộc. Số lượng chỉ số tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu bạn không chỉ định, thì hệ thống sẽ trả về tối đa 50.000 chỉ số. Giá trị tối đa là 50.000; các giá trị lớn hơn 50.000 sẽ được chuyển đổi thành 50.000.
page_token

string

Không bắt buộc. Mã thông báo trang nhận được từ lệnh gọi SearchGauges trước đó. Cung cấp thông tin này để truy xuất trang tiếp theo. Khi phân trang, tất cả các tham số khác được cung cấp cho SearchGauges phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

Trường nhóm search_by.

search_by chỉ có thể là một trong những trạng thái sau:
region_code

string

Tìm kiếm tất cả các đồng hồ đo trong một khu vực theo mã khu vực. Sử dụng https://cldr.unicode.org/ (danh sách https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

Loop

Tìm kiếm tất cả các đồng hồ đo trong một vòng lặp (một đa giác hình cầu đơn giản, xem Loop).
include_non_quality_verified

bool

Không bắt buộc. Đưa vào những chỉ số kết quả chưa được xác minh chất lượng. Hãy thận trọng khi sử dụng. Mặc định là sai.
include_gauges_without_hydro_model

bool

Không bắt buộc. Đưa vào các đồng hồ đo kết quả không có mô hình thuỷ điện nội bộ của Google. Mặc định là sai.

SearchGaugesByAreaResponse

Phản hồi của SearchGaugesByArea.

Trường
gauges[]

Gauge

Các đồng hồ đo được tìm thấy trong khu vực được yêu cầu.
next_page_token

string

Không bắt buộc. Một mã thông báo có thể được gửi dưới dạng page_token để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.

SearchLatestFloodStatusByAreaRequest

Yêu cầu của SearchLatestFloodStatusByArea.

Trường
page_token

string

Không bắt buộc. Mã thông báo trang nhận được từ lệnh gọi SearchLatestFloodStatusByArea trước đó. Cung cấp thông tin này để truy xuất trang tiếp theo. Khi phân trang, tất cả các tham số khác được cung cấp cho SearchLatestFloodStatusByArea phải khớp với lệnh gọi đã cung cấp mã thông báo trang.
page_size

int32

Không bắt buộc. Số lượng trạng thái lũ lụt tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu không chỉ định, hệ thống sẽ trả về tối đa 20.000 trạng thái ngập lụt. Giá trị tối đa là 20.000; các giá trị lớn hơn 20.000 sẽ được chuyển đổi thành 20.000.

Trường nhóm area_type.

area_type chỉ có thể là một trong những trạng thái sau:
region_code

string

Khu vực dùng để truy vấn trạng thái lũ lụt. Sử dụng CLDR, ví dụ: "US".
loop

Loop

Vòng lặp để truy vấn trạng thái lũ lụt.
include_non_quality_verified

bool

Không bắt buộc. Đưa vào những chỉ số kết quả chưa được xác minh chất lượng. Hãy thận trọng khi sử dụng. Mặc định là sai.

SearchLatestFloodStatusByAreaResponse

Phản hồi của SearchLatestFloodStatusByArea.

Trường
flood_statuses[]

FloodStatus

Trạng thái ngập lụt mới nhất ở khu vực được yêu cầu. Hiện tại, điều này được xác định theo vị trí của các đồng hồ đo và có thể thay đổi trong tương lai.
next_page_token

string

Không bắt buộc. Một mã thông báo có thể được gửi dưới dạng page_token để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.

SerializedPolygon

Một đa giác được chuyển đổi tuần tự.

Trường
polygon_id

string

Mã nhận dạng của đa giác.
kml

string

Giá trị biểu thị chuỗi KML của đa giác.

Ngưỡng

Ngưỡng của mô hình thiết bị đo mực nước.

Trường
warning_level

double

Mức cảnh báo.
danger_level

double

Mức độ nguy hiểm.
extreme_danger_level

double

Mức độ nguy hiểm cực kỳ cao. Không phải lúc nào cũng có.

TimeRange

Một phạm vi thời gian.

Trường
start

string

Điểm bắt đầu của phạm vi thời gian. Được biểu thị dưới dạng ISO 8601, ví dụ: "2023-06-17T10:34:00Z".
end

string

Kết thúc phạm vi thời gian. Được biểu thị dưới dạng ISO 8601, ví dụ: "2023-06-17T10:34:00Z".