Package google.maps.mapmanagement.v2alpha

Index

MapManagement

The Map Management API supports CRUD operations on Cloud-based Map Styling resources: MapConfigs, StyleConfigs, and MapContextConfigs. With this API, developers can manage the visual appearance of their maps and style them to their specifications.

CreateMapConfig

rpc CreateMapConfig(CreateMapConfigRequest) returns (MapConfig)

Creates a MapConfig in a project.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateMapContextConfig(CreateMapContextConfigRequest) returns (MapContextConfig)

Creates a MapContextConfig.

Authorization scopes

Requires the following OAuth scope:

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

rpc CreateStyleConfig(CreateStyleConfigRequest) returns (StyleConfig)

Creates a StyleConfig.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteMapConfig(DeleteMapConfigRequest) returns (Empty)

Deletes a MapConfig.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteMapContextConfig(DeleteMapContextConfigRequest) returns (Empty)

Deletes a MapContextConfig.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteStyleConfig(DeleteStyleConfigRequest) returns (Empty)

Deletes a StyleConfig.

Authorization scopes

Requires the following OAuth scope:

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

rpc GetMapConfig(GetMapConfigRequest) returns (MapConfig)

Gets a MapConfig.

Authorization scopes

Requires the following OAuth scope:

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

rpc GetMapContextConfig(GetMapContextConfigRequest) returns (MapContextConfig)

Gets a MapContextConfig.

Authorization scopes

Requires the following OAuth scope:

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

rpc GetStyleConfig(GetStyleConfigRequest) returns (StyleConfig)

Gets a StyleConfig.

Authorization scopes

Requires the following OAuth scope:

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

rpc ListMapConfigs(ListMapConfigsRequest) returns (ListMapConfigsResponse)

Lists MapConfigs for a project.

Authorization scopes

Requires the following OAuth scope:

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

rpc ListMapContextConfigs(ListMapContextConfigsRequest) returns (ListMapContextConfigsResponse)

Lists MapContextConfigs.

Authorization scopes

Requires the following OAuth scope:

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

rpc ListStyleConfigs(ListStyleConfigsRequest) returns (ListStyleConfigsResponse)

Lists StyleConfigs.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateMapConfig(UpdateMapConfigRequest) returns (MapConfig)

Updates a MapConfig.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateMapContextConfig(UpdateMapContextConfigRequest) returns (MapContextConfig)

Updates a MapContextConfig.

Authorization scopes

Requires the following OAuth scope:

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

rpc UpdateStyleConfig(UpdateStyleConfigRequest) returns (StyleConfig)

Updates a StyleConfig.

Authorization scopes

Requires the following OAuth scope:

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

CreateMapConfigRequest

Request to create a MapConfig.

Fields
parent

string

Required. Parent project that will own the MapConfig. Format: projects/{$my-project-id}
map_config

MapConfig

Required. The MapConfig to create.

CreateMapContextConfigRequest

Request to create a MapContextConfig.

Fields
parent

string

Required. Parent MapConfig that will own the MapContextConfig. Format: projects/{project}/mapConfigs/{map_config}
map_context_config

MapContextConfig

Required. The MapContextConfig to create.

CreateStyleConfigRequest

Request to create a StyleConfig.

Fields
parent

string

Required. Parent project that will own the StyleConfig. Format: projects/{project}
style_config

StyleConfig

Required. The StyleConfig to create.

DeleteMapConfigRequest

Request to delete a MapConfig. If the MapConfig has any child MapContextConfigs, those will be deleted as well.

Fields
name

string

Required. Resource name of the MapConfig to delete. Format: projects/{project}/mapConfigs/{map_config}
force

bool

Optional. If set to true, any MapContextConfigs from this MapConfig will also be deleted. (Otherwise, the request will only work if the MapConfig has no MapContextConfigs.)

DeleteMapContextConfigRequest

Request to delete a MapContextConfig.

Fields
name

string

Required. Resource name of the MapContextConfig to delete. Format: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

DeleteStyleConfigRequest

Request to delete a StyleConfig.

Fields
name

string

Required. Resource name of the StyleConfig to delete. Format: projects/{project}/styleConfigs/{style_config}

GetMapConfigRequest

Request to get a MapConfig.

Fields
name

string

Required. Resource name of the MapConfig. Format: projects/{project}/mapConfigs/{map_config}

GetMapContextConfigRequest

Request to get a MapContextConfig.

Fields
name

string

Required. Resource name of the MapContextConfig. Format: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

GetStyleConfigRequest

Request to get a StyleConfig.

Fields
name

string

Required. Resource name of the StyleConfig. Format: projects/{project}/styleConfigs/{style_config}

ListMapConfigsRequest

Request to list MapConfigs.

Fields
parent

string

Required. Parent project that owns the MapConfigs. Format: projects/{project}
page_size

int32

Optional. The maximum number of MapConfigs to return. The service may return fewer than this value. If unspecified, at most 50 MapConfigs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. CURRENTLY UNSUPPORTED.
page_token

string

Optional. A page token, received from a previous ListMapConfigs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListMapConfigs must match the call that provided the page token. CURRENTLY UNSUPPORTED.

ListMapConfigsResponse

Response to list MapConfigs.

Fields
map_configs[]

MapConfig

The list of MapConfigs.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. CURRENTLY UNSUPPORTED.

ListMapContextConfigsRequest

Request to list MapContextConfigs.

Fields
parent

string

Required. Parent MapConfig that owns the MapContextConfigs. Format: projects/{project}/mapConfigs/{map_config}
page_size

int32

Optional. The maximum number of MapContextConfigs to return. The service may return fewer than this value. If unspecified, at most 50 MapContextConfigs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. CURRENTLY UNSUPPORTED.
page_token

string

Optional. A page token, received from a previous ListMapContextConfigs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListMapContextConfigs must match the call that provided the page token. CURRENTLY UNSUPPORTED.

ListMapContextConfigsResponse

Response to list MapContextConfigs.

Fields
map_context_configs[]

MapContextConfig

The MapContextConfigs.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. CURRENTLY UNSUPPORTED.

ListStyleConfigsRequest

Request to list StyleConfigs.

Fields
parent

string

Required. Parent project that owns the StyleConfigs. Format: projects/{project}
page_size

int32

Optional. The maximum number of StyleConfigs to return. The service may return fewer than this value. If unspecified, at most 50 StyleConfigs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. CURRENTLY UNSUPPORTED.
page_token

string

Optional. A page token, received from a previous ListStyleConfigs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListStyleConfigs must match the call that provided the page token. CURRENTLY UNSUPPORTED.
filter

string

Optional. Filter expression for the ListStyleConfigs call. Currently only supports filtering by display_name. For example: display_name="My StyleConfig" will return all StyleConfigs with the display name "My StyleConfig".
view

StyleConfigView

Optional. The subset of the StyleConfig to return. If this is unset, the default behavior is to return the FULL view.

ListStyleConfigsResponse

Response to list StyleConfigs.

Fields
style_configs[]

StyleConfig

The StyleConfigs.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. CURRENTLY UNSUPPORTED.

MapConfig

Represents a single map in a Maps API client application. The MapConfig is the parent resource of MapContextConfigs and enables custom styling in SDKs (Mobile/Web). A MapConfig can have multiple MapContextConfigs, each applying styling to specific map variants. Next ID = 9;

Fields
name

string

Output only. Identifier. Resource name of this MapConfig. For example: "projects/my-project-123/mapConfigs/234". Output only.
display_name

string

Optional. The display name of this MapConfig, as specified by the user.
description

string

Optional. The description of this MapConfig, as specified by the user.
map_id

string

Output only. The Map ID of this MapConfig, used to identify the map in client applications. This read-only field is generated when the MapConfig is created. Output only.
map_features

MapFeatures

Optional. The Map Features that apply to this Map Config.
map_type

MapRenderingType

Optional. Represents the Map Type of the MapConfig. If this is unset, the default behavior is to use the raster map type.
create_time

Timestamp

Output only. Denotes the creation time of the Map Config. Output only.
update_time

Timestamp

Output only. Denotes the last update time of the Map Config. Output only.

MapContextConfig

Encapsulates the styling configuration for a map. The MapContextConfig associates styling components, such as a StyleConfig and Datasets, with specific map variants of a MapConfig. When the MapConfig is loaded in an SDK, the styling and dataset information from the MapContextConfig are applied to the specified map variants. Next ID = 10;

Fields
name

string

Output only. Identifier. Resource name of this MapContextConfig. For example: projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id}
map_config

string

Required. The MapConfig resource name that this MapContextConfig is associated with. Format: projects/{project}/mapConfigs/{map_config}. This field is required and cannot be omitted.
style_config

string

Required. The StyleConfig resource name that is styling this MapContextConfig. This field is required and cannot be omitted. Format: projects/{project}/styleConfigs/{style_config}
dataset[]

string

Optional. The Dataset resource name that is associated with this MapContextConfig. This field is optional and can be omitted. If omitted, no datasets will be associated with the MapContextConfig. If a dataset is specified, it will be applied to the MapContextConfig. Format: projects/{project}/datasets/{dataset}
alias

string

Optional. The user defined human readable name for this MapContextConfig.
map_variants[]

MapVariant

Required. The map variants that this MapContextConfig can be applied to. If empty, the MapContextConfig will be default applied to only the ROADMAP map variant.
create_time

Timestamp

Output only. Denotes the creation time of the MapContextConfig. Output only.
update_time

Timestamp

Output only. Denotes the last update time of the MapContextConfig. Output only.

MapVariant

Possible Map Variants that the MapContextConfig can be applied to. Map Variants are grouped into Light and Dark variants. A Light variant cannot be paired with a Dark variant for the same MapContextConfig. The Light Variants are: ROADMAP, SATELLITE, TERRAIN, NAVIGATION, TRANSIT, ABSTRACT3D, PHOTOREALISTIC3D. The Dark Variants are: ROADMAP_DARK, NAVIGATION_LOW_LIGHT, TERRAIN_DARK, TRANSIT_DARK.

For example, the following is a valid pairing: {MapContextConfig 1: [ROADMAP, NAVIGATION]} {MapContextConfig 2: [ROADMAP_DARK, NAVIGATION_LOW_LIGHT]}

The following is an invalid pairing: {MapContextConfig 1: [ROADMAP, ROADMAP_DARK]}

Enums
ROADMAP The default roadmap map type.
ROADMAP_DARK A dark version of the roadmap map type.
SATELLITE Satellite imagery.
TERRAIN Terrain map type.
TERRAIN_DARK A dark version of the terrain map type.
NAVIGATION Navigation map type.
NAVIGATION_LOW_LIGHT A low light version of the navigation map type.
TRANSIT Transit map type.
TRANSIT_DARK A dark version of the transit map type.
ABSTRACT3D Abstract 3D map type.
PHOTOREALISTIC3D Photorealistic 3D map type.

MapFeatures

Represents a collection of map features that apply to a MapConfig. Features set on a MapConfig are inherited by all of its child MapContextConfigs. Next ID = 3;

Fields
simple_features[]

SimpleFeature

Optional. The visual feature to use for this map.
poi_boost_level

int32

Optional. POI Boost level, where 0 denotes no boostings and negative values denotes de-boosting. Boosted POIs are shown at lower zoom than default and vice versa de-boosted. Currently supports 2 levels of boosting, so the level is clamped to [-2, 2]. If not specified, the POI density defined in the style sheet will be used if it exists. Otherwise, no POI density will be applied.

SimpleFeature

This represents the set of map features that affect the intrinsic structure of the map.

Enums
SIMPLE_FEATURE_UNSPECIFIED Unspecified visual feature.
FLATTEN_BUILDINGS Flattens all buildings in the map.
ICONIC_ICONS Influences how icons are rendered.

MapRenderingType

The type of map to be rendered. The default behavior is RASTER if not specified.

Enums
RASTER A map rendered using the raster based implementation.
VECTOR A map rendered using webGL.

StyleConfig

Represents a single style in a Maps API client application. The StyleConfig contains the style sheet that defines the visual appearance of the map. Next ID = 9;

Fields
name

string

Output only. Identifier. Resource name of this StyleConfig. For example: "projects/my-project-123/styleConfigs/234".
display_name

string

Optional. The display name of this StyleConfig, as specified by the user.
description

string

Optional. The description of this StyleConfig, as specified by the user.
style_id

string

Output only. The unique identifier of this style. This is a read-only field that is generated when the StyleConfig is created. Output only.
json_style_sheet

string

Optional. JSON representation of the style sheet for this StyleConfig. If not specified, the base Google map style will be used. See https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference for more details on the acceptable JSON format.
create_time

Timestamp

Output only. Denotes the creation time of the StyleConfig.
update_time

Timestamp

Output only. Denotes the last update time of the StyleConfig.

StyleConfigView

What subset of the StyleConfig to return.

Enums
STYLE_CONFIG_VIEW_UNSPECIFIED Unspecified view.
FULL Include the json_style_sheet in the response.
METADATA_ONLY Exclude the json_style_sheet from the response.

UpdateMapConfigRequest

Request to update a MapConfig.

Fields
map_config

MapConfig

Required. The MapConfig to update.

The MapConfig's name field is used to identify the MapConfig to update. Format: projects/{project}/mapConfigs/{map_config}
update_mask

FieldMask

Optional. The specific field to update for the MapConfig. If not specified, the MapConfig will be updated in its entirety. Valid fields are:

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

Request to update a MapContextConfig.

Fields
map_context_config

MapContextConfig

Required. The MapContextConfig to update.

The MapContextConfig's name field is used to identify the MapContextConfig to update. Format: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}
update_mask

FieldMask

Optional. The list of fields to update. If not specified, the MapContextConfig will be updated in its entirety. Valid fields are:

  • display_name
  • alias
  • map_variants
  • style_config
  • dataset

UpdateStyleConfigRequest

Request to update a StyleConfig.

Fields
style_config

StyleConfig

Required. The StyleConfig to update.

The StyleConfig's name field is used to identify the StyleConfig to update. Format: projects/{project}/styleConfigs/{style_config}
update_mask

FieldMask

Optional. The list of fields to update. If not specified, the StyleConfig will be updated in its entirety. Valid fields are:

  • display_name
  • description
  • json_style_sheet