Package google.maps.mapmanagement.v2alpha

Chỉ mục

MapManagement

API Quản lý Bản đồ hỗ trợ các thao tác CRUD trên các tài nguyên Định kiểu bản đồ dựa trên đám mây: MapConfigs, StyleConfigs và MapContextConfigs. Với API này, nhà phát triển có thể quản lý giao diện trực quan của bản đồ và tạo kiểu theo quy cách của họ.

CreateMapConfig

rpc CreateMapConfig(CreateMapConfigRequest) returns (MapConfig)

Tạo một MapConfig trong dự án.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
CreateMapContextConfig

rpc CreateMapContextConfig(CreateMapContextConfigRequest) returns (MapContextConfig)

Tạo MapContextConfig.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
CreateStyleConfig

rpc CreateStyleConfig(CreateStyleConfigRequest) returns (StyleConfig)

Tạo một StyleConfig.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
DeleteMapConfig

rpc DeleteMapConfig(DeleteMapConfigRequest) returns (Empty)

Xoá một MapConfig.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
DeleteMapContextConfig

rpc DeleteMapContextConfig(DeleteMapContextConfigRequest) returns (Empty)

Xoá một MapContextConfig.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
DeleteStyleConfig

rpc DeleteStyleConfig(DeleteStyleConfigRequest) returns (Empty)

Xoá một StyleConfig.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
GetMapConfig

rpc GetMapConfig(GetMapConfigRequest) returns (MapConfig)

Nhận MapConfig.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
GetMapContextConfig

rpc GetMapContextConfig(GetMapContextConfigRequest) returns (MapContextConfig)

Nhận MapContextConfig.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
GetStyleConfig

rpc GetStyleConfig(GetStyleConfigRequest) returns (StyleConfig)

Nhận một StyleConfig.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
ListMapConfigs

rpc ListMapConfigs(ListMapConfigsRequest) returns (ListMapConfigsResponse)

Liệt kê MapConfig cho một dự án.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
ListMapContextConfigs

rpc ListMapContextConfigs(ListMapContextConfigsRequest) returns (ListMapContextConfigsResponse)

Liệt kê MapContextConfigs.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
ListStyleConfigs

rpc ListStyleConfigs(ListStyleConfigsRequest) returns (ListStyleConfigsResponse)

Liệt kê StyleConfigs.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
UpdateMapConfig

rpc UpdateMapConfig(UpdateMapConfigRequest) returns (MapConfig)

Cập nhật một MapConfig.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
UpdateMapContextConfig

rpc UpdateMapContextConfig(UpdateMapContextConfigRequest) returns (MapContextConfig)

Cập nhật một MapContextConfig.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform
UpdateStyleConfig

rpc UpdateStyleConfig(UpdateStyleConfigRequest) returns (StyleConfig)

Cập nhật một StyleConfig.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/cloud-platform

CreateMapConfigRequest

Yêu cầu tạo MapConfig.

Trường
parent

string

Bắt buộc. Dự án mẹ sẽ sở hữu MapConfig. Định dạng projects/{$my-project-id}
map_config

MapConfig

Bắt buộc. MapConfig cần tạo.

CreateMapContextConfigRequest

Yêu cầu tạo MapContextConfig.

Trường
parent

string

Bắt buộc. Parent MapConfig sẽ sở hữu MapContextConfig. Định dạng projects/{project}/mapConfigs/{map_config}
map_context_config

MapContextConfig

Bắt buộc. MapContextConfig cần tạo.

CreateStyleConfigRequest

Yêu cầu tạo StyleConfig.

Trường
parent

string

Bắt buộc. Dự án mẹ sẽ sở hữu StyleConfig. Định dạng projects/{project}
style_config

StyleConfig

Bắt buộc. StyleConfig cần tạo.

DeleteMapConfigRequest

Yêu cầu xoá MapConfig. Nếu MapConfig có bất kỳ MapContextConfig con nào, thì những MapContextConfig đó cũng sẽ bị xoá.

Trường
name

string

Bắt buộc. Tên tài nguyên của MapConfig cần xoá. Định dạng projects/{project}/mapConfigs/{map_config}
force

bool

Không bắt buộc. Nếu bạn đặt thành true, mọi MapContextConfigs trong MapConfig này cũng sẽ bị xoá. (Nếu không, yêu cầu sẽ chỉ hoạt động nếu MapConfig không có MapContextConfigs.)

DeleteMapContextConfigRequest

Yêu cầu xoá một MapContextConfig.

Trường
name

string

Bắt buộc. Tên tài nguyên của MapContextConfig cần xoá. Định dạng projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

DeleteStyleConfigRequest

Yêu cầu xoá một StyleConfig.

Trường
name

string

Bắt buộc. Tên tài nguyên của StyleConfig cần xoá. Định dạng projects/{project}/styleConfigs/{style_config}

GetMapConfigRequest

Yêu cầu lấy MapConfig.

Trường
name

string

Bắt buộc. Tên tài nguyên của MapConfig. Định dạng projects/{project}/mapConfigs/{map_config}

GetMapContextConfigRequest

Yêu cầu lấy MapContextConfig.

Trường
name

string

Bắt buộc. Tên tài nguyên của MapContextConfig. Định dạng projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

GetStyleConfigRequest

Yêu cầu lấy StyleConfig.

Trường
name

string

Bắt buộc. Tên tài nguyên của StyleConfig. Định dạng projects/{project}/styleConfigs/{style_config}

ListMapConfigsRequest

Yêu cầu liệt kê MapConfigs.

Trường
parent

string

Bắt buộc. Dự án mẹ sở hữu MapConfigs. Định dạng projects/{project}
page_size

int32

Không bắt buộc. Số lượng MapConfig 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, tối đa 50 MapConfig sẽ được trả về. Giá trị tối đa là 1000; các giá trị lớn hơn 1000 sẽ được chuyển đổi thành 1000. HIỆN KHÔNG ĐƯỢC HỖ TRỢ.
page_token

string

Không bắt buộc. Mã thông báo trang nhận được từ một lệnh gọi ListMapConfigs 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 ListMapConfigs phải khớp với lệnh gọi đã cung cấp mã thông báo trang. HIỆN KHÔNG ĐƯỢC HỖ TRỢ.

ListMapConfigsResponse

Phản hồi cho danh sách MapConfigs.

Trường
map_configs[]

MapConfig

Danh sách MapConfig.
next_page_token

string

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. HIỆN KHÔNG ĐƯỢC HỖ TRỢ.

ListMapContextConfigsRequest

Yêu cầu liệt kê MapContextConfigs.

Trường
parent

string

Bắt buộc. Parent MapConfig sở hữu MapContextConfigs. Định dạng projects/{project}/mapConfigs/{map_config}
page_size

int32

Không bắt buộc. Số lượng MapContextConfigs 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, tối đa 50 MapContextConfigs sẽ được trả về. Giá trị tối đa là 1000; các giá trị lớn hơn 1000 sẽ được chuyển đổi thành 1000. HIỆN KHÔNG ĐƯỢC HỖ TRỢ.
page_token

string

Không bắt buộc. Mã thông báo trang nhận được từ một lệnh gọi ListMapContextConfigs 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 ListMapContextConfigs phải khớp với lệnh gọi đã cung cấp mã thông báo trang. HIỆN KHÔNG ĐƯỢC HỖ TRỢ.

ListMapContextConfigsResponse

Phản hồi cho danh sách MapContextConfigs.

Trường
map_context_configs[]

MapContextConfig

MapContextConfigs.
next_page_token

string

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. HIỆN KHÔNG ĐƯỢC HỖ TRỢ.

ListStyleConfigsRequest

Yêu cầu liệt kê StyleConfigs.

Trường
parent

string

Bắt buộc. Dự án mẹ sở hữu StyleConfigs. Định dạng projects/{project}
page_size

int32

Không bắt buộc. Số lượng StyleConfig 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, tối đa 50 StyleConfig sẽ được trả về. Giá trị tối đa là 1000; các giá trị lớn hơn 1000 sẽ được chuyển đổi thành 1000. HIỆN KHÔNG ĐƯỢC HỖ TRỢ.
page_token

string

Không bắt buộc. Mã thông báo trang nhận được từ một lệnh gọi ListStyleConfigs 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 ListStyleConfigs phải khớp với lệnh gọi đã cung cấp mã thông báo trang. HIỆN KHÔNG ĐƯỢC HỖ TRỢ.
filter

string

Không bắt buộc. Biểu thức bộ lọc cho lệnh gọi ListStyleConfigs. Hiện tại, chỉ hỗ trợ lọc theo display_name. Ví dụ: display_name="My StyleConfig" sẽ trả về tất cả StyleConfig có tên hiển thị là "My StyleConfig".
view

StyleConfigView

Không bắt buộc. Tập hợp con của StyleConfig cần trả về. Nếu bạn không đặt tham số này, hành vi mặc định là trả về chế độ xem ĐẦY ĐỦ.

ListStyleConfigsResponse

Phản hồi cho danh sách StyleConfigs.

Trường
style_configs[]

StyleConfig

StyleConfigs.
next_page_token

string

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. HIỆN KHÔNG ĐƯỢC HỖ TRỢ.

MapConfig

Đại diện cho một bản đồ duy nhất trong ứng dụng Maps API. MapConfig là tài nguyên mẹ của MapContextConfigs và cho phép tạo kiểu tuỳ chỉnh trong SDK (Thiết bị di động/Web). MapConfig có thể có nhiều MapContextConfig, mỗi MapContextConfig áp dụng kiểu cho các biến thể bản đồ cụ thể. Next ID = 9;

Trường
name

string

Chỉ có đầu ra. Giá trị nhận dạng. Tên tài nguyên của MapConfig này. Ví dụ: "projects/my-project-123/mapConfigs/234". Chỉ có đầu ra.
display_name

string

Không bắt buộc. Tên hiển thị của MapConfig này, do người dùng chỉ định.
description

string

Không bắt buộc. Nội dung mô tả về MapConfig này, do người dùng chỉ định.
map_id

string

Chỉ có đầu ra. Mã bản đồ của MapConfig này, dùng để xác định bản đồ trong các ứng dụng khách. Trường chỉ đọc này được tạo khi MapConfig được tạo. Chỉ có đầu ra.
map_features

MapFeatures

Không bắt buộc. Các tính năng của bản đồ áp dụng cho Cấu hình bản đồ này.
map_type

MapRenderingType

Không bắt buộc. Biểu thị Loại bản đồ của MapConfig. Nếu bạn không đặt giá trị này, hoạt động mặc định là sử dụng loại bản đồ raster.
create_time

Timestamp

Chỉ có đầu ra. Cho biết thời gian tạo Cấu hình bản đồ. Chỉ có đầu ra.
update_time

Timestamp

Chỉ có đầu ra. Cho biết thời gian cập nhật gần đây nhất của Cấu hình bản đồ. Chỉ có đầu ra.

MapContextConfig

Đóng gói cấu hình tạo kiểu cho bản đồ. MapContextConfig liên kết các thành phần tạo kiểu (chẳng hạn như StyleConfig và Datasets) với các biến thể bản đồ cụ thể của MapConfig. Khi MapConfig được tải trong một SDK, thông tin về kiểu và tập dữ liệu từ MapContextConfig sẽ được áp dụng cho các biến thể bản đồ được chỉ định. Next ID = 10;

Trường
name

string

Chỉ có đầu ra. Giá trị nhận dạng. Tên tài nguyên của MapContextConfig này. Ví dụ: projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id}
map_config

string

Bắt buộc. Tên tài nguyên MapConfig mà MapContextConfig này được liên kết. Định dạng: projects/{project}/mapConfigs/{map_config}. Đây là trường bắt buộc và không được bỏ qua.
style_config

string

Bắt buộc. Tên tài nguyên StyleConfig đang tạo kiểu cho MapContextConfig này. Đây là trường bắt buộc và không được bỏ qua. Định dạng: projects/{project}/styleConfigs/{style_config}
dataset[]

string

Không bắt buộc. Tên tài nguyên Tập dữ liệu được liên kết với MapContextConfig này. Đây là trường không bắt buộc và bạn có thể bỏ qua. Nếu bạn bỏ qua, sẽ không có tập dữ liệu nào được liên kết với MapContextConfig. Nếu bạn chỉ định một tập dữ liệu, thì tập dữ liệu đó sẽ được áp dụng cho MapContextConfig. Định dạng: projects/{project}/datasets/{dataset}
alias

string

Không bắt buộc. Tên do người dùng xác định mà con người có thể đọc được cho MapContextConfig này.
map_variants[]

MapVariant

Bắt buộc. Các biến thể bản đồ mà MapContextConfig này có thể áp dụng. Nếu trống, MapContextConfig sẽ được áp dụng theo mặc định chỉ cho biến thể bản đồ ROADMAP.
create_time

Timestamp

Chỉ có đầu ra. Biểu thị thời gian tạo MapContextConfig. Chỉ có đầu ra.
update_time

Timestamp

Chỉ có đầu ra. Biểu thị thời gian cập nhật gần đây nhất của MapContextConfig. Chỉ có đầu ra.

MapVariant

Các biến thể có thể có của bản đồ mà bạn có thể áp dụng MapContextConfig. Các biến thể của bản đồ được nhóm thành biến thể Sáng và biến thể Tối. Bạn không thể ghép một biến thể Sáng với một biến thể Tối cho cùng một MapContextConfig. Các biến thể của chế độ sáng là: ROADMAP, SATELLITE, TERRAIN, NAVIGATION, TRANSIT, ABSTRACT3D, PHOTOREALISTIC3D. Các biến thể tối là: ROADMAP_DARK, NAVIGATION_LOW_LIGHT, TERRAIN_DARK, TRANSIT_DARK.

Ví dụ: sau đây là một cặp hợp lệ: {MapContextConfig 1: [ROADMAP, NAVIGATION]} {MapContextConfig 2: [ROADMAP_DARK, NAVIGATION_LOW_LIGHT]}

Sau đây là một cặp không hợp lệ: {MapContextConfig 1: [ROADMAP, ROADMAP_DARK]}

Enum
ROADMAP Loại bản đồ lộ trình mặc định.
ROADMAP_DARK Phiên bản tối của loại bản đồ lộ trình.
SATELLITE Hình ảnh vệ tinh.
TERRAIN Loại bản đồ địa hình.
TERRAIN_DARK Phiên bản tối của loại bản đồ địa hình.
NAVIGATION Loại bản đồ điều hướng.
NAVIGATION_LOW_LIGHT Phiên bản ánh sáng yếu của loại bản đồ chỉ đường.
TRANSIT Loại bản đồ phương tiện công cộng.
TRANSIT_DARK Phiên bản tối của loại bản đồ phương tiện công cộng.
ABSTRACT3D Loại bản đồ 3D trừu tượng.
PHOTOREALISTIC3D Loại bản đồ 3D ảnh thực tế.

MapFeatures

Biểu thị một tập hợp các đối tượng trên bản đồ áp dụng cho MapConfig. Tất cả MapContextConfigs con sẽ kế thừa các đối tượng được đặt trên MapConfig. Next ID = 3;

Trường
simple_features[]

SimpleFeature

Không bắt buộc. Đối tượng trực quan để sử dụng cho bản đồ này.
poi_boost_level

int32

Không bắt buộc. Mức độ tăng cường địa điểm yêu thích, trong đó 0 biểu thị không tăng cường và giá trị âm biểu thị giảm cường độ. Các địa điểm được tăng cường sẽ xuất hiện ở mức thu phóng thấp hơn mức mặc định và ngược lại đối với các địa điểm bị giảm cường độ. Hiện hỗ trợ 2 cấp độ tăng cường, vì vậy cấp độ được giới hạn trong khoảng [-2, 2]. Nếu bạn không chỉ định, thì mật độ POI được xác định trong biểu định kiểu sẽ được sử dụng nếu có. Nếu không, mật độ địa điểm yêu thích sẽ không được áp dụng.

SimpleFeature

Đây là tập hợp các đối tượng trên bản đồ ảnh hưởng đến cấu trúc vốn có của bản đồ.

Enum
SIMPLE_FEATURE_UNSPECIFIED Đối tượng trực quan chưa được chỉ định.
FLATTEN_BUILDINGS Làm phẳng tất cả các toà nhà trên bản đồ.
ICONIC_ICONS Ảnh hưởng đến cách biểu tượng được hiển thị.

MapRenderingType

Loại bản đồ cần kết xuất. Hành vi mặc định là RASTER nếu bạn không chỉ định.

Enum
RASTER Bản đồ được kết xuất bằng cách triển khai dựa trên raster.
VECTOR Bản đồ được kết xuất bằng WebGL.

StyleConfig

Biểu thị một kiểu duy nhất trong ứng dụng Maps API. StyleConfig chứa biểu định kiểu xác định giao diện trực quan của bản đồ. Next ID = 9;

Trường
name

string

Chỉ có đầu ra. Giá trị nhận dạng. Tên tài nguyên của StyleConfig này. Ví dụ: "projects/my-project-123/styleConfigs/234".
display_name

string

Không bắt buộc. Tên hiển thị của StyleConfig này, do người dùng chỉ định.
description

string

Không bắt buộc. Nội dung mô tả về StyleConfig này, do người dùng chỉ định.
style_id

string

Chỉ có đầu ra. Giá trị nhận dạng riêng biệt của kiểu này. Đây là một trường chỉ đọc được tạo khi StyleConfig được tạo. Chỉ có đầu ra.
json_style_sheet

string

Không bắt buộc. Biểu diễn dưới dạng JSON của biểu định kiểu cho StyleConfig này. Nếu bạn không chỉ định, hệ thống sẽ sử dụng kiểu bản đồ cơ bản của Google. Hãy xem https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference để biết thêm thông tin về định dạng JSON được chấp nhận.
create_time

Timestamp

Chỉ có đầu ra. Biểu thị thời gian tạo StyleConfig.
update_time

Timestamp

Chỉ có đầu ra. Cho biết thời gian cập nhật gần đây nhất của StyleConfig.

StyleConfigView

Tập hợp con nào của StyleConfig cần trả về.

Enum
STYLE_CONFIG_VIEW_UNSPECIFIED Chế độ xem không xác định.
FULL Đưa json_style_sheet vào phản hồi.
METADATA_ONLY Loại trừ json_style_sheet khỏi phản hồi.

UpdateMapConfigRequest

Yêu cầu cập nhật MapConfig.

Trường
map_config

MapConfig

Bắt buộc. MapConfig cần cập nhật.

Trường name của MapConfig được dùng để xác định MapConfig cần cập nhật. Định dạng: projects/{project}/mapConfigs/{map_config}
update_mask

FieldMask

Không bắt buộc. Trường cụ thể cần cập nhật cho MapConfig. Nếu bạn không chỉ định, MapConfig sẽ được cập nhật toàn bộ. Các trường hợp lệ là:

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

Yêu cầu cập nhật MapContextConfig.

Trường
map_context_config

MapContextConfig

Bắt buộc. MapContextConfig cần cập nhật.

Trường name của MapContextConfig được dùng để xác định MapContextConfig cần cập nhật. Định dạng: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}
update_mask

FieldMask

Không bắt buộc. Danh sách các trường cần cập nhật. Nếu bạn không chỉ định, MapContextConfig sẽ được cập nhật toàn bộ. Các trường hợp lệ là:

  • display_name
  • alias
  • map_variants
  • style_config
  • dataset

UpdateStyleConfigRequest

Yêu cầu cập nhật StyleConfig.

Trường
style_config

StyleConfig

Bắt buộc. StyleConfig cần cập nhật.

Trường name của StyleConfig được dùng để xác định StyleConfig cần cập nhật. Định dạng: projects/{project}/styleConfigs/{style_config}
update_mask

FieldMask

Không bắt buộc. Danh sách các trường cần cập nhật. Nếu bạn không chỉ định, StyleConfig sẽ được cập nhật toàn bộ. Các trường hợp lệ là:

  • display_name
  • description
  • json_style_sheet