Package google.maps.mapmanagement.v1

Index

MapManagement

Service definition for the Map Management API. The Map Management API currently only supports the management of DatasetStyleAssociations. Using the API, one can create, list, and delete DatasetStyleAssociations. A get method is not needed as the DatasetStyleAssociation is fully characterized by its Dataset and Map Style Ids, so it can be uniquely identified by its name.

CreateDatasetStyleAssociation

rpc CreateDatasetStyleAssociation(CreateDatasetStyleAssociationRequest) returns (DatasetStyleAssociation)

Creates a DatasetStyleAssociation.

Authorization scopes

Requires the following OAuth scope:

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

rpc DeleteDatasetStyleAssociation(DeleteDatasetStyleAssociationRequest) returns (Empty)

Deletes a DatasetStyleAssociation. The delete becomes a special case when the DatasetStyleAssociation is implicitly associated with at least one Map. In this case, the delete is only allowed if the request contains the list of all Map Ids associated with the DatasetStyleAssociation. This is a safeguard put in place to minimize the risk of making destructive changes with unintended side effects.

Authorization scopes

Requires the following OAuth scope:

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

rpc ListDatasetMapAssociations(ListDatasetMapAssociationsRequest) returns (ListDatasetMapAssociationsResponse)

Lists DatasetMapAssociations.

Authorization scopes

Requires the following OAuth scope:

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

rpc ListDatasetStyleAssociations(ListDatasetStyleAssociationsRequest) returns (ListDatasetStyleAssociationsResponse)

Lists DatasetStyleAssociations. Since DatasetStyleAssociations are children of Datasets, the parent Dataset is used to identify the list of DatasetStyleAssociations to return. If the dataset is omitted, e.g. projects/123/datasets/- the returned list will contain all DatasetStyleAssociations for the project.

Authorization scopes

Requires the following OAuth scope:

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

CreateDatasetStyleAssociationRequest

Request to create a DatasetStyleAssociation.

Fields
parent

string

Required. Parent dataset that will own the DatasetStyleAssociation. Format: projects/{$project_number}/datasets/{$dataset_id}

dataset_style_association

DatasetStyleAssociation

Required. A new DatasetStyleAssociation.

DatasetStyleAssociation

An association between a Map Style and a Dataset. This association has the implication that if a Map is associated with the Map Style, then the Map will also be associated with the Dataset as far as visualization is concerned.

Fields
name

string

Resource name of the Dataset - Map Style Association: projects/{project}/datasets/{dataset}/clientStyles/{client_style}

client_style

string

The resource name of the Map Style: projects/{project}/clientStyles/{client_style}

DeleteDatasetStyleAssociationRequest

Request to delete a DatasetStyleAssociation.

Fields
name

string

Required. Format: projects/${project}/datasets/{dataset_id}/clientStyles/{style_id}

map_ids[]

string

Optional. Must be present if and only if the Dataset to be deleted is implicitly associated with at least one Map. This is a safeguard put in place to minimize the risk of making destructive changes with unintended side effects.

ListDatasetMapAssociationsRequest

Request to list all Map Ids implicitly associated to the given Dataset.

Fields
parent

string

Required. The DatasetStyleAssociation to list all associated maps for. The form is projects/{project_id}/datasets/{dataset_id}/clientStyles/{style_id}

page_size

int32

Optional. The maximum number of DatasetMapAssociations to return. The service may return fewer than this value. If unspecified, at most 20 DatasetMapAssociations will be returned. The maximum value is 50.

page_token

string

Optional. A page token, received from a previous ListDatasetMapAssociations call. Provide this to retrieve the subsequent page. When paginating, all parameters must match the original call.

ListDatasetMapAssociationsResponse

A list of Map Ids implicitly associated to a given Dataset.

Fields
map_ids[]

string

A list of Map Ids implicitly associated to a given Dataset.

next_page_token

string

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

ListDatasetStyleAssociationsRequest

Request to list all DatasetStyleAssociations for the project.

Fields
parent

string

Required. The name of the project to list all DatasetStyleAssociations for.

page_size

int32

Optional. The maximum number of DatasetStyleAssociations to return. The service may return fewer than this value. If unspecified, at most 20 DatasetStyleAssociations will be returned. The maximum value is 50.

page_token

string

Optional. A page token, received from a previous ListDatasetStyleAssociations call. Provide this to retrieve the subsequent page. When paginating, all parameters must match the original call.

ListDatasetStyleAssociationsResponse

A list of DatasetStyleAssociations.

Fields
dataset_style_associations[]

DatasetStyleAssociation

A list of DatasetStyleAssociations.

next_page_token

string

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