Package google.maps.mapmanagement.v2alpha

Индекс

Управление картами

API управления картами поддерживает операции CRUD с облачными ресурсами стилизации карт: MapConfigs, StyleConfigs и MapContextConfigs. С помощью этого API разработчики могут управлять визуальным оформлением своих карт и стилизовать их в соответствии со своими требованиями.

CreateMapConfig

rpc CreateMapConfig( CreateMapConfigRequest ) returns ( MapConfig )

Создает объект MapConfig в проекте.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc CreateMapContextConfig( CreateMapContextConfigRequest ) returns ( MapContextConfig )

Создает MapContextConfig.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc CreateStyleConfig( CreateStyleConfigRequest ) returns ( StyleConfig )

Создает StyleConfig.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc DeleteMapConfig( DeleteMapConfigRequest ) returns ( Empty )

Удаляет MapConfig.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc DeleteMapContextConfig( DeleteMapContextConfigRequest ) returns ( Empty )

Удаляет MapContextConfig.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc DeleteStyleConfig( DeleteStyleConfigRequest ) returns ( Empty )

Удаляет StyleConfig.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc GetMapConfig( GetMapConfigRequest ) returns ( MapConfig )

Получает объект MapConfig.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc GetMapContextConfig( GetMapContextConfigRequest ) returns ( MapContextConfig )

Получает объект MapContextConfig.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc GetStyleConfig( GetStyleConfigRequest ) returns ( StyleConfig )

Получает объект StyleConfig.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc ListMapConfigs( ListMapConfigsRequest ) returns ( ListMapConfigsResponse )

Выводит список конфигураций карт (MapConfig) для проекта.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc ListMapContextConfigs( ListMapContextConfigsRequest ) returns ( ListMapContextConfigsResponse )

Отображает список конфигураций MapContextConfig.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc ListStyleConfigs( ListStyleConfigsRequest ) returns ( ListStyleConfigsResponse )

Отображает список конфигураций стилей.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc UpdateMapConfig( UpdateMapConfigRequest ) returns ( MapConfig )

Обновляет MapConfig.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc UpdateMapContextConfig( UpdateMapContextConfigRequest ) returns ( MapContextConfig )

Обновляет MapContextConfig.

Области полномочий

Требуется следующая область действия OAuth:

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

rpc UpdateStyleConfig( UpdateStyleConfigRequest ) returns ( StyleConfig )

Обновляет StyleConfig.

Области полномочий

Требуется следующая область действия OAuth:

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

CreateMapConfigRequest

Запрос на создание MapConfig.

Поля
parent

string

Обязательно. Родительский проект, которому будет принадлежать MapConfig. Формат: projects/{$my-project-id}

map_config

MapConfig

Обязательно. Конфигурация карты (MapConfig) для создания.

CreateMapContextConfigRequest

Запрос на создание MapContextConfig.

Поля
parent

string

Обязательно. Родительский MapConfig, которому будет принадлежать MapContextConfig. Формат: projects/{project}/mapConfigs/{map_config}

map_context_config

MapContextConfig

Обязательно. Конфигурация MapContextConfig для создания.

CreateStyleConfigRequest

Запрос на создание StyleConfig.

Поля
parent

string

Обязательно. Родительский проект, которому будет принадлежать файл StyleConfig. Формат: projects/{project}

style_config

StyleConfig

Обязательно. Конфигурация стиля для создания.

DeleteMapConfigRequest

Запрос на удаление объекта MapConfig. Если у объекта MapConfig есть дочерние объекты MapContextConfig, они также будут удалены.

Поля
name

string

Обязательно. Имя ресурса MapConfig для удаления. Формат: projects/{project}/mapConfigs/{map_config}

force

bool

Необязательно. Если установлено значение true, все MapContextConfig из этого MapConfig также будут удалены. (В противном случае запрос будет работать только в том случае, если у MapConfig нет MapContextConfig.)

DeleteMapContextConfigRequest

Запрос на удаление объекта MapContextConfig.

Поля
name

string

Обязательно. Имя ресурса MapContextConfig для удаления. Формат: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

DeleteStyleConfigRequest

Запрос на удаление StyleConfig.

Поля
name

string

Обязательно. Имя ресурса StyleConfig для удаления. Формат: projects/{project}/styleConfigs/{style_config}

GetMapConfigRequest

Запрос на получение MapConfig.

Поля
name

string

Обязательно. Имя ресурса MapConfig. Формат: projects/{project}/mapConfigs/{map_config}

GetMapContextConfigRequest

Запрос на получение объекта MapContextConfig.

Поля
name

string

Обязательно. Имя ресурса MapContextConfig. Формат: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

GetStyleConfigRequest

Запрос на получение StyleConfig.

Поля
name

string

Обязательно. Имя ресурса StyleConfig. Формат: projects/{project}/styleConfigs/{style_config}

ListMapConfigsRequest

Запрос на отображение списка конфигураций карт (MapConfigs).

Поля
parent

string

Обязательно. Родительский проект, которому принадлежат MapConfigs. Формат: projects/{project}

page_size

int32

Необязательный параметр. Максимальное количество возвращаемых MapConfig. Сервис может вернуть меньше этого значения. Если параметр не указан, будет возвращено не более 50 MapConfig. Максимальное значение — 1000; значения выше 1000 будут преобразованы в 1000. В НАСТОЯЩЕЕ ВРЕМЯ НЕ ПОДДЕРЖИВАЕТСЯ.

page_token

string

Необязательный параметр. Токен страницы, полученный из предыдущего вызова ListMapConfigs . Укажите его, чтобы получить следующую страницу.

При постраничной навигации все остальные параметры, передаваемые в ListMapConfigs , должны соответствовать вызову, который предоставил токен страницы. В НАСТОЯЩЕЕ ВРЕМЯ НЕ ПОДДЕРЖИВАЕТСЯ.

ListMapConfigsResponse

Ответ на запрос списка MapConfigs.

Поля
map_configs[]

MapConfig

Список MapConfigs.

next_page_token

string

Токен, который можно отправить в качестве page_token для получения следующей страницы. Если это поле опущено, последующих страниц не будет. В НАСТОЯЩЕЕ ВРЕМЯ НЕ ПОДДЕРЖИВАЕТСЯ.

ListMapContextConfigsRequest

Запрос на отображение списка MapContextConfigs.

Поля
parent

string

Обязательно. Родительский MapConfig, которому принадлежат MapContextConfigs. Формат: projects/{project}/mapConfigs/{map_config}

page_size

int32

Необязательный параметр. Максимальное количество возвращаемых MapContextConfig. Сервис может вернуть меньше этого значения. Если параметр не указан, будет возвращено не более 50 MapContextConfig. Максимальное значение — 1000; значения выше 1000 будут преобразованы в 1000. В НАСТОЯЩЕЕ ВРЕМЯ НЕ ПОДДЕРЖИВАЕТСЯ.

page_token

string

Необязательный параметр. Токен страницы, полученный из предыдущего вызова ListMapContextConfigs . Укажите его, чтобы получить следующую страницу.

При постраничной навигации все остальные параметры, передаваемые в ListMapContextConfigs , должны соответствовать вызову, который предоставил токен страницы. В НАСТОЯЩЕЕ ВРЕМЯ НЕ ПОДДЕРЖИВАЕТСЯ.

ListMapContextConfigsResponse

Ответ на запрос списка MapContextConfigs.

Поля
map_context_configs[]

MapContextConfig

Конфигурации MapContextConfigs.

next_page_token

string

Токен, который можно отправить в качестве page_token для получения следующей страницы. Если это поле опущено, последующих страниц не будет. В НАСТОЯЩЕЕ ВРЕМЯ НЕ ПОДДЕРЖИВАЕТСЯ.

ListStyleConfigsRequest

Запрос на отображение списка StyleConfigs.

Поля
parent

string

Обязательно. Родительский проект, которому принадлежат файлы StyleConfigs. Формат: projects/{project}

page_size

int32

Необязательный параметр. Максимальное количество возвращаемых StyleConfig. Сервис может вернуть меньше этого значения. Если параметр не указан, будет возвращено не более 50 StyleConfig. Максимальное значение — 1000; значения выше 1000 будут преобразованы в 1000. В НАСТОЯЩЕЕ ВРЕМЯ НЕ ПОДДЕРЖИВАЕТСЯ.

page_token

string

Необязательный параметр. Токен страницы, полученный из предыдущего вызова ListStyleConfigs . Укажите его, чтобы получить следующую страницу.

При постраничной навигации все остальные параметры, передаваемые в ListStyleConfigs , должны соответствовать вызову, который предоставил токен страницы. В НАСТОЯЩЕЕ ВРЕМЯ НЕ ПОДДЕРЖИВАЕТСЯ.

filter

string

Необязательный параметр. Выражение фильтра для вызова ListStyleConfigs. В настоящее время поддерживается только фильтрация по display_name. Например: display_name="My StyleConfig" вернет все StyleConfigs с отображаемым именем "My StyleConfig".

view

StyleConfigView

Необязательный параметр. Подмножество StyleConfig, которое необходимо вернуть. Если этот параметр не задан, по умолчанию возвращается ПОЛНОЕ представление.

ListStyleConfigsResponse

Ответ на запрос списка StyleConfigs.

Поля
style_configs[]

StyleConfig

StyleConfigs.

next_page_token

string

Токен, который можно отправить в качестве page_token для получения следующей страницы. Если это поле опущено, последующих страниц не будет. В НАСТОЯЩЕЕ ВРЕМЯ НЕ ПОДДЕРЖИВАЕТСЯ.

MapConfig

Представляет собой отдельную карту в клиентском приложении Maps API. MapConfig является родительским ресурсом для MapContextConfigs и позволяет настраивать стиль в SDK (мобильных/веб-приложениях). MapConfig может содержать несколько MapContextConfigs, каждый из которых применяет стиль к определенным вариантам карты. Следующий ID = 9;

Поля
name

string

Только вывод. Идентификатор. Имя ресурса этого MapConfig. Например: "projects/my-project-123/mapConfigs/234". Только вывод.

display_name

string

Необязательно. Отображаемое имя этого MapConfig, указанное пользователем.

description

string

Необязательно. Описание этого объекта MapConfig, указанное пользователем.

map_id

string

Только для вывода. Идентификатор карты (Map ID) этого MapConfig, используемый для идентификации карты в клиентских приложениях. Это поле только для чтения генерируется при создании MapConfig. Только для вывода.

map_features

MapFeatures

Необязательно. Функции карты, которые применяются к данной конфигурации карты.

map_type

MapRenderingType

Необязательный параметр. Представляет тип карты в MapConfig. Если он не задан, по умолчанию используется растровый тип карты.

create_time

Timestamp

Только для вывода. Обозначает время создания конфигурации карты. Только для вывода.

update_time

Timestamp

Только для вывода. Обозначает время последнего обновления конфигурации карты. Только для вывода.

MapContextConfig

Инкапсулирует конфигурацию стилей для карты. MapContextConfig связывает компоненты стилей, такие как StyleConfig и Datasets, с конкретными вариантами карты MapConfig. При загрузке MapConfig в SDK информация о стилях и наборах данных из MapContextConfig применяется к указанным вариантам карты. Next ID = 10;

Поля
name

string

Только вывод. Идентификатор. Имя ресурса этого MapContextConfig. Например: projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id}

map_config

string

Обязательно. Имя ресурса MapConfig, с которым связан данный MapContextConfig. Формат: projects/{project}/mapConfigs/{map_config}. Это поле обязательно и не может быть опущено.

style_config

string

Обязательно. Имя ресурса StyleConfig, который стилизует этот MapContextConfig. Это поле обязательно и не может быть опущено. Формат: projects/{project}/styleConfigs/{style_config}

dataset[]

string

Необязательно. Имя ресурса Dataset, связанного с этим MapContextConfig. Это поле необязательно и может быть опущено. Если оно опущено, с MapContextConfig не будут связаны никакие наборы данных. Если указан набор данных, он будет применен к MapContextConfig. Формат: projects/{project}/datasets/{dataset}

alias

string

Необязательно. Пользовательское удобочитаемое имя для этого объекта MapContextConfig.

map_variants[]

MapVariant

Обязательно. Варианты карты, к которым может быть применен этот MapContextConfig. Если поле пустое, MapContextConfig будет применяться по умолчанию только к варианту карты ROADMAP.

create_time

Timestamp

Только для вывода. Обозначает время создания MapContextConfig. Только для вывода.

update_time

Timestamp

Только для вывода. Обозначает время последнего обновления MapContextConfig. Только для вывода.

MapVariant

Возможные варианты карт, к которым может быть применена конфигурация MapContextConfig. Варианты карт сгруппированы в светлые и темные. Светлый вариант не может быть связан с темным вариантом для одной и той же конфигурации MapContextConfig. Светлые варианты: ROADMAP, SATELLITE, TERRAIN, NAVIGATION, TRANSIT, ABSTRACT3D, PHOTOREALISTIC3D. Темные варианты: ROADMAP_DARK, NAVIGATION_LOW_LIGHT, TERRAIN_DARK, TRANSIT_DARK.

Например, допустимой парой является следующая: {MapContextConfig 1: [ROADMAP, NAVIGATION]} {MapContextConfig 2: [ROADMAP_DARK, NAVIGATION_LOW_LIGHT]}

Следующая пара является недопустимой: {MapContextConfig 1: [ROADMAP, ROADMAP_DARK]}

Перечисления
ROADMAP Тип дорожной карты по умолчанию.
ROADMAP_DARK Темная версия карты типа "дорожная карта".
SATELLITE Спутниковые снимки.
TERRAIN Тип карты местности.
TERRAIN_DARK Темный вариант карты местности.
NAVIGATION Тип навигационной карты.
NAVIGATION_LOW_LIGHT Вариант навигационной карты с низким уровнем освещенности.
TRANSIT Тип карты общественного транспорта.
TRANSIT_DARK Темный вариант карты общественного транспорта.
ABSTRACT3D Абстрактный тип 3D-карты.
PHOTOREALISTIC3D Фотореалистичная 3D-карта.

MapFeatures

Представляет собой набор картографических объектов, применяемых к MapConfig. Объекты, заданные в MapConfig, наследуются всеми его дочерними MapContextConfig. Следующий ID = 3;

Поля
simple_features[]

SimpleFeature

Необязательно. Визуальный элемент, который следует использовать для этой карты.

poi_boost_level

int32

Необязательный параметр. Уровень усиления POI, где 0 означает отсутствие усиления, а отрицательные значения — его отсутствие. Усиленные POI отображаются с меньшим масштабом, чем по умолчанию, и наоборот — с меньшим. В настоящее время поддерживаются 2 уровня усиления, поэтому уровень ограничен диапазоном [-2, 2]. Если не указано, будет использоваться плотность POI, определенная в таблице стилей, если она существует. В противном случае плотность POI применяться не будет.

SimpleFeature

Это представляет собой набор картографических элементов, влияющих на внутреннюю структуру карты.

Перечисления
SIMPLE_FEATURE_UNSPECIFIED Неуказанная визуальная особенность.
FLATTEN_BUILDINGS Сносит все здания на карте.
ICONIC_ICONS Влияет на способ отображения иконок.

MapRenderingType

Тип отображаемой карты. По умолчанию используется растровый формат, если не указано иное.

Перечисления
RASTER Карта, отрисованная с использованием растровой реализации.
VECTOR Карта, созданная с использованием WebGL.

StyleConfig

Представляет собой отдельный стиль в клиентском приложении Maps API. StyleConfig содержит таблицу стилей, определяющую визуальное оформление карты. Next ID = 9;

Поля
name

string

Только вывод. Идентификатор. Имя ресурса этого StyleConfig. Например: "projects/my-project-123/styleConfigs/234".

display_name

string

Необязательно. Отображаемое имя этого StyleConfig, указанное пользователем.

description

string

Необязательно. Описание этого StyleConfig, указанное пользователем.

style_id

string

Только для вывода. Уникальный идентификатор этого стиля. Это поле только для чтения, которое генерируется при создании StyleConfig. Только для вывода.

json_style_sheet

string

Необязательно. JSON-представление таблицы стилей для этого StyleConfig. Если не указано, будет использоваться базовый стиль карты Google. Дополнительные сведения о допустимом формате JSON см. на странице https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference .

create_time

Timestamp

Только для вывода. Обозначает время создания StyleConfig.

update_time

Timestamp

Только для вывода. Обозначает время последнего обновления StyleConfig.

StyleConfigView

Какое подмножество StyleConfig следует вернуть?

Перечисления
STYLE_CONFIG_VIEW_UNSPECIFIED Неуказанное мнение.
FULL Включите файл json_style_sheet в ответ.
METADATA_ONLY Исключите элемент json_style_sheet из ответа.

UpdateMapConfigRequest

Запрос на обновление MapConfig.

Поля
map_config

MapConfig

Обязательно. Конфигурация карты (MapConfig) для обновления.

Поле name в MapConfig используется для идентификации объекта MapConfig, который необходимо обновить. Формат: projects/{project}/mapConfigs/{map_config}

update_mask

FieldMask

Необязательно. Конкретное поле для обновления в MapConfig. Если не указано, MapConfig будет обновлен полностью. Допустимые поля:

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

Запрос на обновление MapContextConfig.

Поля
map_context_config

MapContextConfig

Обязательно. Необходимо обновить MapContextConfig.

Поле name объекта MapContextConfig используется для идентификации объекта MapContextConfig, который необходимо обновить. Формат: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

update_mask

FieldMask

Необязательный параметр. Список полей для обновления. Если не указан, будет обновлен весь MapContextConfig. Допустимые поля:

  • display_name
  • alias
  • map_variants
  • style_config
  • dataset

UpdateStyleConfigRequest

Запрос на обновление StyleConfig.

Поля
style_config

StyleConfig

Обязательно. Конфигурация стиля для обновления.

Поле name в StyleConfig используется для идентификации StyleConfig, который необходимо обновить. Формат: projects/{project}/styleConfigs/{style_config}

update_mask

FieldMask

Необязательный параметр. Список полей для обновления. Если не указано, будет обновлен весь файл StyleConfig. Допустимые поля:

  • display_name
  • description
  • json_style_sheet