Package google.maps.mapmanagement.v2beta

索引

接口 MapManagement

地图管理 API 的服务定义。

方法
CreateMapConfig 在项目中创建 MapConfig。
CreateMapContextConfig 创建 MapContextConfig。
CreateStyleConfig 创建 StyleConfig。
DeleteMapConfig 删除 MapConfig。
DeleteMapContextConfig 删除 MapContextConfig。
DeleteStyleConfig 删除 StyleConfig。
GetMapConfig 获取 MapConfig。
GetMapContextConfig 获取 MapContextConfig。
GetStyleConfig 获取 StyleConfig。
ListMapConfigs 列出项目的 MapConfig。
ListMapContextConfigs 列出 MapContextConfig。
ListStyleConfigs 列出 StyleConfig。
UpdateMapConfig 更新 MapConfig。
UpdateMapContextConfig 更新 MapContextConfig。
UpdateStyleConfig 更新 StyleConfig。

CreateMapConfigRequest

创建 MapConfig 的请求。

字段
parent

string

必需。将拥有 MapConfig 的父项目。格式：projects/{project}
map_config

MapConfig

必需。要创建的 MapConfig。

CreateMapContextConfigRequest

创建 MapContextConfig 的请求。

字段
parent

string

必需。将拥有 MapContextConfig 的父 MapConfig。格式：projects/{project}/mapConfigs/{map_config}
map_context_config

MapContextConfig

必需。要创建的 MapContextConfig。

CreateStyleConfigRequest

创建 StyleConfig 的请求。

字段
parent

string

必需。将拥有 StyleConfig 的父项目。格式：projects/{project}
style_config

StyleConfig

必需。要创建的 StyleConfig。

DeleteMapConfigRequest

用于删除 MapConfig 的请求。

字段
name

string

必需。要删除的 MapConfig 的名称。格式：projects/{project}/mapConfigs/{map_config}

DeleteMapContextConfigRequest

用于删除 MapContextConfig 的请求。

字段
name

string

必需。要删除的 MapContextConfig 的名称。格式：projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

DeleteStyleConfigRequest

用于删除 StyleConfig 的请求。

字段
name

string

必需。要删除的 StyleConfig 的名称。格式：projects/{project}/styleConfigs/{style_config}

GetMapConfigRequest

用于获取 MapConfig 的请求。

字段
name

string

必需。要检索的 MapConfig 的名称。格式：projects/{project}/mapConfigs/{map_config}

GetMapContextConfigRequest

用于获取 MapContextConfig 的请求。

字段
name

string

必需。要检索的 MapContextConfig 的名称。格式：projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

GetStyleConfigRequest

获取 StyleConfig 的请求。

字段
name

string

必需。要检索的 StyleConfig 的名称。格式：projects/{project}/styleConfigs/{style_config}
view

StyleConfigView

可选。要返回的 StyleConfig 的子集。如果未设置此字段，则默认行为是返回 FULL 视图。

ListMapConfigsRequest

请求列出项目的 MapConfig。

字段
parent

string

必需。拥有 MapConfigs 的父项目。格式：projects/{project}
page_size

int32

可选。要返回的 MapConfig 的数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 50 个 MapConfig。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。 目前不受支持。
page_token

string

可选。从之前的 ListMapConfigs 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，提供给 ListMapConfigs 的所有其他参数必须与提供页面令牌的调用匹配。 目前不受支持。

ListMapConfigsResponse

列出 MapConfig 的响应。

字段
map_configs[]

MapConfig

MapConfig 的列表。
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。 目前不受支持。

ListMapContextConfigsRequest

请求列出 MapContextConfig 的请求。

字段
parent

string

必需。拥有 MapContextConfigs 的父 MapConfig。格式：projects/{project}/mapConfigs/{map_config}
page_size

int32

可选。要返回的 MapContextConfig 的数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 50 个 MapContextConfig。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。 目前不受支持。
page_token

string

可选。从之前的 ListMapContextConfigs 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，提供给 ListMapContextConfigs 的所有其他参数必须与提供页面令牌的调用匹配。 目前不受支持。

ListMapContextConfigsResponse

列出 MapContextConfig 的响应。

字段
map_context_configs[]

MapContextConfig

MapContextConfigs。
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。 目前不受支持。

ListStyleConfigsRequest

列出 StyleConfig 的请求。

字段
parent

string

必需。拥有 StyleConfigs 的父项目。格式：projects/{project}
page_size

int32

可选。要返回的 StyleConfig 的数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 50 个 StyleConfig。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。 目前不受支持。
page_token

string

可选。从之前的 ListStyleConfigs 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，提供给 ListStyleConfigs 的所有其他参数必须与提供页面令牌的调用匹配。 目前不受支持。
filter

string

可选。针对 ListStyleConfigs 调用的过滤表达式。目前仅支持按 display_name 进行过滤。例如：display_name="My StyleConfig" 将返回显示名为“My StyleConfig”的所有 StyleConfig。
view

StyleConfigView

可选。要返回的 StyleConfig 的子集。如果未设置此字段，则默认行为是返回 FULL 视图。

ListStyleConfigsResponse

列出 StyleConfig 的响应。

字段
style_configs[]

StyleConfig

StyleConfigs。
next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。 目前不受支持。

MapConfig

表示 Maps API 客户端应用中的单个地图。MapConfig 是 MapContextConfigs 的父资源，可在 SDK（移动/Web）中实现自定义样式。一个 MapConfig 可以有多个 MapContextConfig，每个 MapContextConfig 都可将样式应用于特定的地图变体。下一个 ID = 9；

字段
name

string

仅限输出。标识符。相应 MapConfig 的资源名称。例如：“projects/my-project-123/mapConfigs/234”。仅限输出。
display_name

string

可选。相应 MapConfig 的显示名称（由用户指定）。
description

string

可选。相应 MapConfig 的说明，由用户指定。
map_id

string

仅限输出。相应 MapConfig 的地图 ID，用于在客户端应用中标识地图。此只读字段是在创建 MapConfig 时生成的。仅限输出。
map_features

MapFeatures

可选。适用于相应地图配置的地图项。
map_type

MapRenderingType

可选。表示 MapConfig 的地图类型。如果未设置此属性，默认行为是使用光栅地图类型。
create_time

Timestamp

仅限输出。表示地图配置的创建时间。仅限输出。
update_time

Timestamp

仅限输出。表示地图配置的上次更新时间。仅限输出。

MapContextConfig

封装地图的样式配置。MapContextConfig 将样式组件（例如 StyleConfig 和数据集）与 MapConfig 的特定地图变体相关联。当 MapConfig 在 SDK 中加载时，MapContextConfig 中的样式和数据集信息会应用于指定的地图变体。下一个 ID = 10；

字段
name

string

仅限输出。标识符。相应 MapContextConfig 的资源名称。例如：projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id}
map_config

string

必需。与此 MapContextConfig 关联的 MapConfig 资源名称。格式：projects/{project}/mapConfigs/{map_config}。此字段为必填字段，不得省略。
style_config

string

必需。用于设置相应 MapContextConfig 样式的 StyleConfig 资源名称。此字段是必需字段，不得省略。格式：projects/{project}/styleConfigs/{style_config}
dataset[]

string

可选。与此 MapContextConfig 关联的数据集资源名称。此字段是可选字段，可以省略。如果省略，则不会有任何数据集与 MapContextConfig 相关联。如果指定了数据集，则会将其应用于 MapContextConfig。格式：projects/{project}/datasets/{dataset}
alias

string

可选。相应 MapContextConfig 的用户定义的人类可读名称。
map_variants[]

MapVariant

必需。相应 MapContextConfig 可应用于的地图变体。如果为空，则 MapContextConfig 将默认仅应用于 ROADMAP 地图变体。
create_time

Timestamp

仅限输出。表示 MapContextConfig 的创建时间。仅限输出。
update_time

Timestamp

仅限输出。表示 MapContextConfig 的上次更新时间。仅限输出。

MapVariant

MapContextConfig 可应用于的可能地图变体。地图变体分为浅色变体和深色变体。对于同一 MapContextConfig，浅色变体无法与深色变体配对。浅色变体包括：ROADMAP、SATELLITE、TERRAIN、NAVIGATION、TRANSIT、ABSTRACT3D、PHOTOREALISTIC3D。深色变体包括：ROADMAP_DARK、NAVIGATION_LOW_LIGHT、TERRAIN_DARK、TRANSIT_DARK。

例如，以下是有效的配对：{MapContextConfig 1: [ROADMAP, NAVIGATION]} {MapContextConfig 2: [ROADMAP_DARK, NAVIGATION_LOW_LIGHT]}

以下是无效的配对：{MapContextConfig 1: [ROADMAP, ROADMAP_DARK]}

枚举
ROADMAP 默认的路线图地图类型。
ROADMAP_DARK 路线图地图类型的深色版本。
SATELLITE 卫星图像。
TERRAIN 地形地图类型。
TERRAIN_DARK 地形地图类型的深色版本。
NAVIGATION 导航地图类型。
NAVIGATION_LOW_LIGHT 导航地图类型的低光版本。
TRANSIT 公交地图类型。
TRANSIT_DARK 交通地图类型的深色版本。
ABSTRACT3D 抽象 3D 地图类型。
PHOTOREALISTIC3D 仿真 3D 地图类型。

MapFeatures

表示适用于 MapConfig 的地图项集合。在 MapConfig 上设置的功能会由其所有子 MapContextConfig 继承。下一个 ID = 3；

字段
simple_features[]

SimpleFeature

可选。要用于相应地图的视觉功能。
poi_boost_level

int32

可选。POI 加推级别，其中 0 表示不加推，负值表示降推。提升了热度的地图注点会以比默认缩放级别更低的缩放级别显示，反之亦然。目前支持 2 个级别的提升，因此级别限制为 [-2, 2]。如果未指定，系统会使用样式表中定义的 POI 密度（如果存在）。否则，系统不会应用任何地图注点密度。

SimpleFeature

这表示影响地图内在结构的一组地图功能。

枚举
SIMPLE_FEATURE_UNSPECIFIED 未指定的视觉特征。
FLATTEN_BUILDINGS 使地图中的所有建筑物变平。
ICONIC_ICONS 影响图标的呈现方式。

MapRenderingType

要渲染的地图类型。如果未指定，则默认行为为 RASTER。

枚举
RASTER 使用基于光栅的实现渲染的地图。
VECTOR 使用 WebGL 渲染的地图。

StyleConfig

表示地图 API 客户端应用中的单个样式。StyleConfig 包含用于定义地图视觉外观的样式表。下一个 ID = 9；

字段
name

string

仅限输出。标识符。相应 StyleConfig 的资源名称。例如：“projects/my-project-123/styleConfigs/234”。
display_name

string

可选。相应 StyleConfig 的显示名称（由用户指定）。
description

string

可选。相应 StyleConfig 的说明（由用户指定）。
style_id

string

仅限输出。相应样式的唯一标识符。此字段是只读字段，在创建 StyleConfig 时生成。仅限输出。
json_style_sheet

string

可选。相应 StyleConfig 的样式表的 JSON 表示形式。如果未指定，系统将使用基本的 Google 地图样式。如需详细了解可接受的 JSON 格式，请参阅 https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference。
create_time

Timestamp

仅限输出。表示 StyleConfig 的创建时间。
update_time

Timestamp

仅限输出。表示 StyleConfig 的上次更新时间。

StyleConfigView

要返回的 StyleConfig 的子集。

枚举
STYLE_CONFIG_VIEW_UNSPECIFIED 未指定的视图。
FULL 在响应中包含 json_style_sheet。
METADATA_ONLY 从响应中排除 json_style_sheet。

UpdateMapConfigRequest

用于更新 MapConfig 的请求。

字段
map_config

MapConfig

必需。要更新的 MapConfig。

MapConfig 的 name 字段用于标识要更新的 MapConfig。格式：projects/{project}/mapConfigs/{map_config}
update_mask

FieldMask

可选。要为 MapConfig 更新的特定字段。如果未指定，则会更新整个 MapConfig。有效字段包括：

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

用于更新 MapContextConfig 的请求。

字段
map_context_config

MapContextConfig

必需。要更新的 MapContextConfig。

MapContextConfig 的 name 字段用于标识要更新的 MapContextConfig。格式：projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}
update_mask

FieldMask

可选。要更新的字段列表。 如果未指定，则系统会更新整个 MapContextConfig。有效字段包括：

  • display_name
  • alias
  • map_variants
  • style_config
  • dataset

UpdateStyleConfigRequest

用于更新 StyleConfig 的请求。

字段
style_config

StyleConfig

必需。要更新的 StyleConfig。

StyleConfig 的 name 字段用于标识要更新的 StyleConfig。格式：projects/{project}/styleConfigs/{style_config}
update_mask

FieldMask

可选。要更新的字段列表。 如果未指定，系统将更新整个 StyleConfig。有效字段包括：

  • display_name
  • description
  • json_style_sheet