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.

MapManagement

class google.maps.mapmanagement_v2beta.services.map_management.MapManagementAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.maps.mapmanagement_v2beta.services.map_management.transports.base.MapManagementTransport, typing.Callable[[...], google.maps.mapmanagement_v2beta.services.map_management.transports.base.MapManagementTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

The Map Management API uses your inputs to create and manage Google Cloud based styling resources for Google Maps.

Using this API, you can can create and manage MapConfigs (Map IDs), StyleConfigs (JSON-based styling), and MapContextConfigs (associations between styles, datasets, and map variants).

This API offers features through three channels:

  • v2alpha: Experimental features.

  • v2beta: Preview features, recommended for early adoption.

  • v2: General Availability (GA) features.

Capabilities described here are generally available across both the v2alpha and v2beta endpoints.

Instantiates the map management async client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Optional[Union[str,MapManagementTransport,Callable[..., MapManagementTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the MapManagementTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint: str

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static common_billing_account_path(billing_account: str) str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) str

Returns a fully-qualified location string.

static common_organization_path(organization: str) str

Returns a fully-qualified organization string.

static common_project_path(project: str) str

Returns a fully-qualified project string.

async create_map_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.CreateMapConfigRequest, dict]] = None, *, parent: Optional[str] = None, map_config: Optional[google.maps.mapmanagement_v2beta.types.map_management_service.MapConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.MapConfig[source]

Creates a MapConfig in a project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_create_map_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.CreateMapConfigRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_map_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.CreateMapConfigRequest, dict]]) – The request object. Request to create a MapConfig.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • map_config (google.maps.mapmanagement_v2beta.types.MapConfig) – Required. The MapConfig to create. This corresponds to the map_config field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.MapConfig

async create_map_context_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.CreateMapContextConfigRequest, dict]] = None, *, parent: Optional[str] = None, map_context_config: Optional[google.maps.mapmanagement_v2beta.types.map_management_service.MapContextConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.MapContextConfig[source]

Creates a MapContextConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_create_map_context_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    map_context_config = mapmanagement_v2beta.MapContextConfig()
    map_context_config.map_config = "map_config_value"
    map_context_config.style_config = "style_config_value"
    map_context_config.map_variants = ['PHOTOREALISTIC3D']

    request = mapmanagement_v2beta.CreateMapContextConfigRequest(
        parent="parent_value",
        map_context_config=map_context_config,
    )

    # Make the request
    response = await client.create_map_context_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.CreateMapContextConfigRequest, dict]]) – The request object. Request to create a MapContextConfig.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • map_context_config (google.maps.mapmanagement_v2beta.types.MapContextConfig) –

    Required. The MapContextConfig to create.

    This corresponds to the map_context_config field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.MapContextConfig

async create_style_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.CreateStyleConfigRequest, dict]] = None, *, parent: Optional[str] = None, style_config: Optional[google.maps.mapmanagement_v2beta.types.map_management_service.StyleConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.StyleConfig[source]

Creates a StyleConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_create_style_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.CreateStyleConfigRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_style_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.CreateStyleConfigRequest, dict]]) – The request object. Request to create a StyleConfig.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • style_config (google.maps.mapmanagement_v2beta.types.StyleConfig) – Required. The StyleConfig to create. This corresponds to the style_config field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.StyleConfig

static dataset_path(project: str, dataset: str) str

Returns a fully-qualified dataset string.

async delete_map_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.DeleteMapConfigRequest, dict]] = None, *, name: Optional[str] = None, force: Optional[bool] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) None[source]

Deletes a MapConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_delete_map_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.DeleteMapConfigRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_map_config(request=request)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.DeleteMapConfigRequest, dict]]) – The request object. Request to delete a MapConfig. If the MapConfig has any child MapContextConfigs, those will be deleted as well.

  • name (str) –

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

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

    This corresponds to the force field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

async delete_map_context_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.DeleteMapContextConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) None[source]

Deletes a MapContextConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_delete_map_context_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.DeleteMapContextConfigRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_map_context_config(request=request)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.DeleteMapContextConfigRequest, dict]]) – The request object. Request to delete a MapContextConfig.

  • name (str) –

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

async delete_style_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.DeleteStyleConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) None[source]

Deletes a StyleConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_delete_style_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.DeleteStyleConfigRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_style_config(request=request)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.DeleteStyleConfigRequest, dict]]) – The request object. Request to delete a StyleConfig.

  • name (str) –

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

MapManagementAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

MapManagementAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

MapManagementAsyncClient

async get_map_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.GetMapConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.MapConfig[source]

Gets a MapConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_get_map_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.GetMapConfigRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_map_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.GetMapConfigRequest, dict]]) – The request object. Request to get a MapConfig.

  • name (str) –

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.MapConfig

async get_map_context_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.GetMapContextConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.MapContextConfig[source]

Gets a MapContextConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_get_map_context_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.GetMapContextConfigRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_map_context_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.GetMapContextConfigRequest, dict]]) – The request object. Request to get a MapContextConfig.

  • name (str) –

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.MapContextConfig

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_style_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.GetStyleConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.StyleConfig[source]

Gets a StyleConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_get_style_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.GetStyleConfigRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_style_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.GetStyleConfigRequest, dict]]) – The request object. Request to get a StyleConfig.

  • name (str) –

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.StyleConfig

classmethod get_transport_class(label: Optional[str] = None) Type[google.maps.mapmanagement_v2beta.services.map_management.transports.base.MapManagementTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async list_map_configs(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.ListMapConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.services.map_management.pagers.ListMapConfigsAsyncPager[source]

Lists MapConfigs for a project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_list_map_configs():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.ListMapConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_map_configs(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.ListMapConfigsRequest, dict]]) – The request object. Request to list MapConfigs.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

Response to list MapConfigs.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.maps.mapmanagement_v2beta.services.map_management.pagers.ListMapConfigsAsyncPager

async list_map_context_configs(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.ListMapContextConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.services.map_management.pagers.ListMapContextConfigsAsyncPager[source]

Lists MapContextConfigs.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_list_map_context_configs():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.ListMapContextConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_map_context_configs(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.ListMapContextConfigsRequest, dict]]) – The request object. Request to list MapContextConfigs.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

Response to list MapContextConfigs.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.maps.mapmanagement_v2beta.services.map_management.pagers.ListMapContextConfigsAsyncPager

async list_style_configs(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.ListStyleConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.services.map_management.pagers.ListStyleConfigsAsyncPager[source]

Lists StyleConfigs.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_list_style_configs():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.ListStyleConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_style_configs(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.ListStyleConfigsRequest, dict]]) – The request object. Request to list StyleConfigs.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

Response to list StyleConfigs.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.maps.mapmanagement_v2beta.services.map_management.pagers.ListStyleConfigsAsyncPager

static map_config_path(project: str, map_config: str) str

Returns a fully-qualified map_config string.

static map_context_config_path(project: str, map_config: str, map_context_config: str) str

Returns a fully-qualified map_context_config string.

static parse_common_billing_account_path(path: str) Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) Dict[str, str]

Parse a project path into its component segments.

static parse_dataset_path(path: str) Dict[str, str]

Parses a dataset path into its component segments.

static parse_map_config_path(path: str) Dict[str, str]

Parses a map_config path into its component segments.

static parse_map_context_config_path(path: str) Dict[str, str]

Parses a map_context_config path into its component segments.

static parse_style_config_path(path: str) Dict[str, str]

Parses a style_config path into its component segments.

static style_config_path(project: str, style_config: str) str

Returns a fully-qualified style_config string.

property transport: google.maps.mapmanagement_v2beta.services.map_management.transports.base.MapManagementTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

MapManagementTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used

by the client instance.

Return type

str

async update_map_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.UpdateMapConfigRequest, dict]] = None, *, map_config: Optional[google.maps.mapmanagement_v2beta.types.map_management_service.MapConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.MapConfig[source]

Updates a MapConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_update_map_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.UpdateMapConfigRequest(
    )

    # Make the request
    response = await client.update_map_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.UpdateMapConfigRequest, dict]]) – The request object. Request to update a MapConfig.

  • map_config (google.maps.mapmanagement_v2beta.types.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}

    This corresponds to the map_config field on the request instance; if request is provided, this should not be set.

  • update_mask (google.protobuf.field_mask_pb2.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

    This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.MapConfig

async update_map_context_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.UpdateMapContextConfigRequest, dict]] = None, *, map_context_config: Optional[google.maps.mapmanagement_v2beta.types.map_management_service.MapContextConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.MapContextConfig[source]

Updates a MapContextConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_update_map_context_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    map_context_config = mapmanagement_v2beta.MapContextConfig()
    map_context_config.map_config = "map_config_value"
    map_context_config.style_config = "style_config_value"
    map_context_config.map_variants = ['PHOTOREALISTIC3D']

    request = mapmanagement_v2beta.UpdateMapContextConfigRequest(
        map_context_config=map_context_config,
    )

    # Make the request
    response = await client.update_map_context_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.UpdateMapContextConfigRequest, dict]]) – The request object. Request to update a MapContextConfig.

  • map_context_config (google.maps.mapmanagement_v2beta.types.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}

    This corresponds to the map_context_config field on the request instance; if request is provided, this should not be set.

  • update_mask (google.protobuf.field_mask_pb2.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

    This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.MapContextConfig

async update_style_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.UpdateStyleConfigRequest, dict]] = None, *, style_config: Optional[google.maps.mapmanagement_v2beta.types.map_management_service.StyleConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.StyleConfig[source]

Updates a StyleConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

async def sample_update_style_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementAsyncClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.UpdateStyleConfigRequest(
    )

    # Make the request
    response = await client.update_style_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Optional[Union[google.maps.mapmanagement_v2beta.types.UpdateStyleConfigRequest, dict]]) – The request object. Request to update a StyleConfig.

  • style_config (google.maps.mapmanagement_v2beta.types.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}

    This corresponds to the style_config field on the request instance; if request is provided, this should not be set.

  • update_mask (google.protobuf.field_mask_pb2.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

    This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.StyleConfig

class google.maps.mapmanagement_v2beta.services.map_management.MapManagementClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.maps.mapmanagement_v2beta.services.map_management.transports.base.MapManagementTransport, typing.Callable[[...], google.maps.mapmanagement_v2beta.services.map_management.transports.base.MapManagementTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

The Map Management API uses your inputs to create and manage Google Cloud based styling resources for Google Maps.

Using this API, you can can create and manage MapConfigs (Map IDs), StyleConfigs (JSON-based styling), and MapContextConfigs (associations between styles, datasets, and map variants).

This API offers features through three channels:

  • v2alpha: Experimental features.

  • v2beta: Preview features, recommended for early adoption.

  • v2: General Availability (GA) features.

Capabilities described here are generally available across both the v2alpha and v2beta endpoints.

Instantiates the map management client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Optional[Union[str,MapManagementTransport,Callable[..., MapManagementTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the MapManagementTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint: str

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static common_billing_account_path(billing_account: str) str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str) str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str) str[source]

Returns a fully-qualified project string.

create_map_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.CreateMapConfigRequest, dict]] = None, *, parent: Optional[str] = None, map_config: Optional[google.maps.mapmanagement_v2beta.types.map_management_service.MapConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.MapConfig[source]

Creates a MapConfig in a project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_create_map_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.CreateMapConfigRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_map_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.CreateMapConfigRequest, dict]) – The request object. Request to create a MapConfig.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • map_config (google.maps.mapmanagement_v2beta.types.MapConfig) – Required. The MapConfig to create. This corresponds to the map_config field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.MapConfig

create_map_context_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.CreateMapContextConfigRequest, dict]] = None, *, parent: Optional[str] = None, map_context_config: Optional[google.maps.mapmanagement_v2beta.types.map_management_service.MapContextConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.MapContextConfig[source]

Creates a MapContextConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_create_map_context_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    map_context_config = mapmanagement_v2beta.MapContextConfig()
    map_context_config.map_config = "map_config_value"
    map_context_config.style_config = "style_config_value"
    map_context_config.map_variants = ['PHOTOREALISTIC3D']

    request = mapmanagement_v2beta.CreateMapContextConfigRequest(
        parent="parent_value",
        map_context_config=map_context_config,
    )

    # Make the request
    response = client.create_map_context_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.CreateMapContextConfigRequest, dict]) – The request object. Request to create a MapContextConfig.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • map_context_config (google.maps.mapmanagement_v2beta.types.MapContextConfig) –

    Required. The MapContextConfig to create.

    This corresponds to the map_context_config field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.MapContextConfig

create_style_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.CreateStyleConfigRequest, dict]] = None, *, parent: Optional[str] = None, style_config: Optional[google.maps.mapmanagement_v2beta.types.map_management_service.StyleConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.StyleConfig[source]

Creates a StyleConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_create_style_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.CreateStyleConfigRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_style_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.CreateStyleConfigRequest, dict]) – The request object. Request to create a StyleConfig.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • style_config (google.maps.mapmanagement_v2beta.types.StyleConfig) – Required. The StyleConfig to create. This corresponds to the style_config field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.StyleConfig

static dataset_path(project: str, dataset: str) str[source]

Returns a fully-qualified dataset string.

delete_map_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.DeleteMapConfigRequest, dict]] = None, *, name: Optional[str] = None, force: Optional[bool] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) None[source]

Deletes a MapConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_delete_map_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.DeleteMapConfigRequest(
        name="name_value",
    )

    # Make the request
    client.delete_map_config(request=request)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.DeleteMapConfigRequest, dict]) – The request object. Request to delete a MapConfig. If the MapConfig has any child MapContextConfigs, those will be deleted as well.

  • name (str) –

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

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

    This corresponds to the force field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

delete_map_context_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.DeleteMapContextConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) None[source]

Deletes a MapContextConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_delete_map_context_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.DeleteMapContextConfigRequest(
        name="name_value",
    )

    # Make the request
    client.delete_map_context_config(request=request)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.DeleteMapContextConfigRequest, dict]) – The request object. Request to delete a MapContextConfig.

  • name (str) –

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

delete_style_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.DeleteStyleConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) None[source]

Deletes a StyleConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_delete_style_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.DeleteStyleConfigRequest(
        name="name_value",
    )

    # Make the request
    client.delete_style_config(request=request)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.DeleteStyleConfigRequest, dict]) – The request object. Request to delete a StyleConfig.

  • name (str) –

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

MapManagementClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

MapManagementClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

MapManagementClient

get_map_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.GetMapConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.MapConfig[source]

Gets a MapConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_get_map_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.GetMapConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_map_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.GetMapConfigRequest, dict]) – The request object. Request to get a MapConfig.

  • name (str) –

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.MapConfig

get_map_context_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.GetMapContextConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.MapContextConfig[source]

Gets a MapContextConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_get_map_context_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.GetMapContextConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_map_context_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.GetMapContextConfigRequest, dict]) – The request object. Request to get a MapContextConfig.

  • name (str) –

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.MapContextConfig

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_style_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.GetStyleConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.StyleConfig[source]

Gets a StyleConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_get_style_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.GetStyleConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_style_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.GetStyleConfigRequest, dict]) – The request object. Request to get a StyleConfig.

  • name (str) –

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.StyleConfig

list_map_configs(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.ListMapConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.services.map_management.pagers.ListMapConfigsPager[source]

Lists MapConfigs for a project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_list_map_configs():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.ListMapConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_map_configs(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.ListMapConfigsRequest, dict]) – The request object. Request to list MapConfigs.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

Response to list MapConfigs.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.maps.mapmanagement_v2beta.services.map_management.pagers.ListMapConfigsPager

list_map_context_configs(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.ListMapContextConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.services.map_management.pagers.ListMapContextConfigsPager[source]

Lists MapContextConfigs.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_list_map_context_configs():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.ListMapContextConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_map_context_configs(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.ListMapContextConfigsRequest, dict]) – The request object. Request to list MapContextConfigs.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

Response to list MapContextConfigs.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.maps.mapmanagement_v2beta.services.map_management.pagers.ListMapContextConfigsPager

list_style_configs(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.ListStyleConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.services.map_management.pagers.ListStyleConfigsPager[source]

Lists StyleConfigs.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_list_style_configs():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.ListStyleConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_style_configs(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.ListStyleConfigsRequest, dict]) – The request object. Request to list StyleConfigs.

  • parent (str) –

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

Response to list StyleConfigs.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.maps.mapmanagement_v2beta.services.map_management.pagers.ListStyleConfigsPager

static map_config_path(project: str, map_config: str) str[source]

Returns a fully-qualified map_config string.

static map_context_config_path(project: str, map_config: str, map_context_config: str) str[source]

Returns a fully-qualified map_context_config string.

static parse_common_billing_account_path(path: str) Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) Dict[str, str][source]

Parse a project path into its component segments.

static parse_dataset_path(path: str) Dict[str, str][source]

Parses a dataset path into its component segments.

static parse_map_config_path(path: str) Dict[str, str][source]

Parses a map_config path into its component segments.

static parse_map_context_config_path(path: str) Dict[str, str][source]

Parses a map_context_config path into its component segments.

static parse_style_config_path(path: str) Dict[str, str][source]

Parses a style_config path into its component segments.

static style_config_path(project: str, style_config: str) str[source]

Returns a fully-qualified style_config string.

property transport: google.maps.mapmanagement_v2beta.services.map_management.transports.base.MapManagementTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

MapManagementTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str

update_map_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.UpdateMapConfigRequest, dict]] = None, *, map_config: Optional[google.maps.mapmanagement_v2beta.types.map_management_service.MapConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.MapConfig[source]

Updates a MapConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_update_map_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.UpdateMapConfigRequest(
    )

    # Make the request
    response = client.update_map_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.UpdateMapConfigRequest, dict]) – The request object. Request to update a MapConfig.

  • map_config (google.maps.mapmanagement_v2beta.types.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}

    This corresponds to the map_config field on the request instance; if request is provided, this should not be set.

  • update_mask (google.protobuf.field_mask_pb2.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

    This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.MapConfig

update_map_context_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.UpdateMapContextConfigRequest, dict]] = None, *, map_context_config: Optional[google.maps.mapmanagement_v2beta.types.map_management_service.MapContextConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.MapContextConfig[source]

Updates a MapContextConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_update_map_context_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    map_context_config = mapmanagement_v2beta.MapContextConfig()
    map_context_config.map_config = "map_config_value"
    map_context_config.style_config = "style_config_value"
    map_context_config.map_variants = ['PHOTOREALISTIC3D']

    request = mapmanagement_v2beta.UpdateMapContextConfigRequest(
        map_context_config=map_context_config,
    )

    # Make the request
    response = client.update_map_context_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.UpdateMapContextConfigRequest, dict]) – The request object. Request to update a MapContextConfig.

  • map_context_config (google.maps.mapmanagement_v2beta.types.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}

    This corresponds to the map_context_config field on the request instance; if request is provided, this should not be set.

  • update_mask (google.protobuf.field_mask_pb2.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

    This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.MapContextConfig

update_style_config(request: Optional[Union[google.maps.mapmanagement_v2beta.types.map_management_service.UpdateStyleConfigRequest, dict]] = None, *, style_config: Optional[google.maps.mapmanagement_v2beta.types.map_management_service.StyleConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()) google.maps.mapmanagement_v2beta.types.map_management_service.StyleConfig[source]

Updates a StyleConfig.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.maps import mapmanagement_v2beta

def sample_update_style_config():
    # Create a client
    client = mapmanagement_v2beta.MapManagementClient()

    # Initialize request argument(s)
    request = mapmanagement_v2beta.UpdateStyleConfigRequest(
    )

    # Make the request
    response = client.update_style_config(request=request)

    # Handle the response
    print(response)
Parameters
  • request (Union[google.maps.mapmanagement_v2beta.types.UpdateStyleConfigRequest, dict]) – The request object. Request to update a StyleConfig.

  • style_config (google.maps.mapmanagement_v2beta.types.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}

    This corresponds to the style_config field on the request instance; if request is provided, this should not be set.

  • update_mask (google.protobuf.field_mask_pb2.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

    This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, Union[str, bytes]]]) – Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns

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;

Return type

google.maps.mapmanagement_v2beta.types.StyleConfig

class google.maps.mapmanagement_v2beta.services.map_management.pagers.ListMapConfigsAsyncPager(method: Callable[[...], Awaitable[google.maps.mapmanagement_v2beta.types.map_management_service.ListMapConfigsResponse]], request: google.maps.mapmanagement_v2beta.types.map_management_service.ListMapConfigsRequest, response: google.maps.mapmanagement_v2beta.types.map_management_service.ListMapConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]

A pager for iterating through list_map_configs requests.

This class thinly wraps an initial google.maps.mapmanagement_v2beta.types.ListMapConfigsResponse object, and provides an __aiter__ method to iterate through its map_configs field.

If there are more pages, the __aiter__ method will make additional ListMapConfigs requests and continue to iterate through the map_configs field on the corresponding responses.

All the usual google.maps.mapmanagement_v2beta.types.ListMapConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.maps.mapmanagement_v2beta.services.map_management.pagers.ListMapConfigsPager(method: Callable[[...], google.maps.mapmanagement_v2beta.types.map_management_service.ListMapConfigsResponse], request: google.maps.mapmanagement_v2beta.types.map_management_service.ListMapConfigsRequest, response: google.maps.mapmanagement_v2beta.types.map_management_service.ListMapConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]

A pager for iterating through list_map_configs requests.

This class thinly wraps an initial google.maps.mapmanagement_v2beta.types.ListMapConfigsResponse object, and provides an __iter__ method to iterate through its map_configs field.

If there are more pages, the __iter__ method will make additional ListMapConfigs requests and continue to iterate through the map_configs field on the corresponding responses.

All the usual google.maps.mapmanagement_v2beta.types.ListMapConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.maps.mapmanagement_v2beta.services.map_management.pagers.ListMapContextConfigsAsyncPager(method: Callable[[...], Awaitable[google.maps.mapmanagement_v2beta.types.map_management_service.ListMapContextConfigsResponse]], request: google.maps.mapmanagement_v2beta.types.map_management_service.ListMapContextConfigsRequest, response: google.maps.mapmanagement_v2beta.types.map_management_service.ListMapContextConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]

A pager for iterating through list_map_context_configs requests.

This class thinly wraps an initial google.maps.mapmanagement_v2beta.types.ListMapContextConfigsResponse object, and provides an __aiter__ method to iterate through its map_context_configs field.

If there are more pages, the __aiter__ method will make additional ListMapContextConfigs requests and continue to iterate through the map_context_configs field on the corresponding responses.

All the usual google.maps.mapmanagement_v2beta.types.ListMapContextConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.maps.mapmanagement_v2beta.services.map_management.pagers.ListMapContextConfigsPager(method: Callable[[...], google.maps.mapmanagement_v2beta.types.map_management_service.ListMapContextConfigsResponse], request: google.maps.mapmanagement_v2beta.types.map_management_service.ListMapContextConfigsRequest, response: google.maps.mapmanagement_v2beta.types.map_management_service.ListMapContextConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]

A pager for iterating through list_map_context_configs requests.

This class thinly wraps an initial google.maps.mapmanagement_v2beta.types.ListMapContextConfigsResponse object, and provides an __iter__ method to iterate through its map_context_configs field.

If there are more pages, the __iter__ method will make additional ListMapContextConfigs requests and continue to iterate through the map_context_configs field on the corresponding responses.

All the usual google.maps.mapmanagement_v2beta.types.ListMapContextConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.maps.mapmanagement_v2beta.services.map_management.pagers.ListStyleConfigsAsyncPager(method: Callable[[...], Awaitable[google.maps.mapmanagement_v2beta.types.map_management_service.ListStyleConfigsResponse]], request: google.maps.mapmanagement_v2beta.types.map_management_service.ListStyleConfigsRequest, response: google.maps.mapmanagement_v2beta.types.map_management_service.ListStyleConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]

A pager for iterating through list_style_configs requests.

This class thinly wraps an initial google.maps.mapmanagement_v2beta.types.ListStyleConfigsResponse object, and provides an __aiter__ method to iterate through its style_configs field.

If there are more pages, the __aiter__ method will make additional ListStyleConfigs requests and continue to iterate through the style_configs field on the corresponding responses.

All the usual google.maps.mapmanagement_v2beta.types.ListStyleConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.maps.mapmanagement_v2beta.services.map_management.pagers.ListStyleConfigsPager(method: Callable[[...], google.maps.mapmanagement_v2beta.types.map_management_service.ListStyleConfigsResponse], request: google.maps.mapmanagement_v2beta.types.map_management_service.ListStyleConfigsRequest, response: google.maps.mapmanagement_v2beta.types.map_management_service.ListStyleConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, Union[str, bytes]]] = ())[source]

A pager for iterating through list_style_configs requests.

This class thinly wraps an initial google.maps.mapmanagement_v2beta.types.ListStyleConfigsResponse object, and provides an __iter__ method to iterate through its style_configs field.

If there are more pages, the __iter__ method will make additional ListStyleConfigs requests and continue to iterate through the style_configs field on the corresponding responses.

All the usual google.maps.mapmanagement_v2beta.types.ListStyleConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters