As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Maps Mapmanagement v2beta API

class google.maps.mapmanagement_v2beta.types.CreateMapConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to create a MapConfig.

parent

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

Type

str

map_config

Required. The MapConfig to create.

Type

google.maps.mapmanagement_v2beta.types.MapConfig

class google.maps.mapmanagement_v2beta.types.CreateMapContextConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to create a MapContextConfig.

parent

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

Type

str

map_context_config

Required. The MapContextConfig to create.

Type

google.maps.mapmanagement_v2beta.types.MapContextConfig

class google.maps.mapmanagement_v2beta.types.CreateStyleConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to create a StyleConfig.

parent

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

Type

str

style_config

Required. The StyleConfig to create.

Type

google.maps.mapmanagement_v2beta.types.StyleConfig

class google.maps.mapmanagement_v2beta.types.DeleteMapConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

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

Type

str

force

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.)

Type

bool

class google.maps.mapmanagement_v2beta.types.DeleteMapContextConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to delete a MapContextConfig.

name

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

Type

str

class google.maps.mapmanagement_v2beta.types.DeleteStyleConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to delete a StyleConfig.

name

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

Type

str

class google.maps.mapmanagement_v2beta.types.GetMapConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to get a MapConfig.

name

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

Type

str

class google.maps.mapmanagement_v2beta.types.GetMapContextConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to get a MapContextConfig.

name

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

Type

str

class google.maps.mapmanagement_v2beta.types.GetStyleConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to get a StyleConfig.

name

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

Type

str

class google.maps.mapmanagement_v2beta.types.ListMapConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to list MapConfigs.

parent

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

Type

str

page_size

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.

Type

int

page_token

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.

Type

str

class google.maps.mapmanagement_v2beta.types.ListMapConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response to list MapConfigs.

map_configs

The list of MapConfigs.

Type

MutableSequence[google.maps.mapmanagement_v2beta.types.MapConfig]

next_page_token

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.

Type

str

class google.maps.mapmanagement_v2beta.types.ListMapContextConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to list MapContextConfigs.

parent

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

Type

str

page_size

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.

Type

int

page_token

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.

Type

str

class google.maps.mapmanagement_v2beta.types.ListMapContextConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response to list MapContextConfigs.

map_context_configs

The MapContextConfigs.

Type

MutableSequence[google.maps.mapmanagement_v2beta.types.MapContextConfig]

next_page_token

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.

Type

str

class google.maps.mapmanagement_v2beta.types.ListStyleConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to list StyleConfigs.

parent

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

Type

str

page_size

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.

Type

int

page_token

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.

Type

str

filter

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”.

Type

str

view

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

Type

google.maps.mapmanagement_v2beta.types.StyleConfigView

class google.maps.mapmanagement_v2beta.types.ListStyleConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response to list StyleConfigs.

style_configs

The StyleConfigs.

Type

MutableSequence[google.maps.mapmanagement_v2beta.types.StyleConfig]

next_page_token

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.

Type

str

class google.maps.mapmanagement_v2beta.types.MapConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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;

name

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

Type

str

display_name

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

Type

str

description

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

Type

str

map_id

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.

Type

str

map_features

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

Type

google.maps.mapmanagement_v2beta.types.MapFeatures

create_time

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

This field is a member of oneof _create_time.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

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

This field is a member of oneof _update_time.

Type

google.protobuf.timestamp_pb2.Timestamp

map_type

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

Type

google.maps.mapmanagement_v2beta.types.MapRenderingType

class google.maps.mapmanagement_v2beta.types.MapContextConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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;

name

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

Type

str

map_config

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.

Type

str

style_config

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

Type

str

dataset

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}

Type

MutableSequence[str]

alias

Optional. The user defined human readable name for this MapContextConfig.

Type

str

map_variants

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.

Type

MutableSequence[google.maps.mapmanagement_v2beta.types.MapContextConfig.MapVariant]

create_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

class MapVariant(value)

Bases: proto.enums.Enum

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]}

Values:

ROADMAP (0):

The default roadmap map type. If no map variants are specified in a MapContextConfig, this variant is used by default.

ROADMAP_DARK (1):

A dark version of the roadmap map type.

SATELLITE (2):

Satellite imagery.

TERRAIN (3):

Terrain map type.

TERRAIN_DARK (4):

A dark version of the terrain map type.

NAVIGATION (5):

Navigation map type.

NAVIGATION_LOW_LIGHT (6):

A low light version of the navigation map type.

TRANSIT (7):

Transit map type.

TRANSIT_DARK (8):

A dark version of the transit map type.

ABSTRACT3D (9):

Abstract 3D map type.

PHOTOREALISTIC3D (10):

Photorealistic 3D map type.

class google.maps.mapmanagement_v2beta.types.MapFeatures(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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;

simple_features

Optional. The visual feature to use for this map.

Type

MutableSequence[google.maps.mapmanagement_v2beta.types.MapFeatures.SimpleFeature]

poi_boost_level

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.

This field is a member of oneof _poi_boost_level.

Type

int

class SimpleFeature(value)

Bases: proto.enums.Enum

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

Values:

SIMPLE_FEATURE_UNSPECIFIED (0):

Unspecified visual feature.

FLATTEN_BUILDINGS (1):

Flattens all buildings in the map.

ICONIC_ICONS (2):

Influences how icons are rendered.

class google.maps.mapmanagement_v2beta.types.MapRenderingType(value)

Bases: proto.enums.Enum

The type of map to be rendered.

Values:

RASTER (0):

A map rendered using the raster based implementation. This is the default rendering type if not specified.

VECTOR (1):

A map rendered using webGL.

class google.maps.mapmanagement_v2beta.types.StyleConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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;

name

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

Type

str

display_name

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

Type

str

description

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

Type

str

style_id

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

Type

str

json_style_sheet

Optional. JSON representation of the style sheet for this StyleConfig. If not specified or if provided as an empty string, the base unstyled 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.

Type

str

create_time

Output only. Denotes the creation time of the StyleConfig.

This field is a member of oneof _create_time.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

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

This field is a member of oneof _update_time.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.maps.mapmanagement_v2beta.types.StyleConfigView(value)

Bases: proto.enums.Enum

What subset of the StyleConfig to return.

Values:

STYLE_CONFIG_VIEW_UNSPECIFIED (0):

Unspecified view.

FULL (1):

Include the json_style_sheet in the response.

METADATA_ONLY (2):

Exclude the json_style_sheet from the response.

class google.maps.mapmanagement_v2beta.types.UpdateMapConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to update a MapConfig.

map_config

Required. The MapConfig to update.

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

Type

google.maps.mapmanagement_v2beta.types.MapConfig

update_mask

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

Type

google.protobuf.field_mask_pb2.FieldMask

class google.maps.mapmanagement_v2beta.types.UpdateMapContextConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to update a MapContextConfig.

map_context_config

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}

Type

google.maps.mapmanagement_v2beta.types.MapContextConfig

update_mask

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

Type

google.protobuf.field_mask_pb2.FieldMask

class google.maps.mapmanagement_v2beta.types.UpdateStyleConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to update a StyleConfig.

style_config

Required. The StyleConfig to update.

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

Type

google.maps.mapmanagement_v2beta.types.StyleConfig

update_mask

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

Type

google.protobuf.field_mask_pb2.FieldMask