Package google.maps.mapmanagement.v2beta

Индекс

интерфейс MapManagement

Service definition for the Map Management API.

Методы
CreateMapConfig Создает объект MapConfig в проекте.
CreateMapContextConfig Создает MapContextConfig.
CreateStyleConfig Создает StyleConfig.
DeleteMapConfig Удаляет MapConfig.
DeleteMapContextConfig Удаляет MapContextConfig.
DeleteStyleConfig Удаляет StyleConfig.
GetMapConfig Получает объект MapConfig.
GetMapContextConfig Получает объект MapContextConfig.
GetStyleConfig Получает объект StyleConfig.
ListMapConfigs Выводит список конфигураций карт (MapConfig) для проекта.
ListMapContextConfigs Отображает список конфигураций MapContextConfig.
ListStyleConfigs Отображает список конфигураций стилей.
UpdateMapConfig Обновляет MapConfig.
UpdateMapContextConfig Обновляет MapContextConfig.
UpdateStyleConfig Обновляет StyleConfig.

CreateMapConfigRequest

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

Поля
parent

string

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

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

Request to delete a MapConfig.

Поля
name

string

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

DeleteMapContextConfigRequest

Request to delete a MapContextConfig.

Поля
name

string

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

DeleteStyleConfigRequest

Request to delete a StyleConfig.

Поля
name

string

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

GetMapConfigRequest

Request to get a MapConfig.

Поля
name

string

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

GetMapContextConfigRequest

Request to get a MapContextConfig.

Поля
name

string

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

GetStyleConfigRequest

Request to get a StyleConfig.

Поля
name

string

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

view

StyleConfigView

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

ListMapConfigsRequest

Request to list MapConfigs for a project.

Поля
parent

string

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

page_size

int32

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

page_token

string

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

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

ListMapConfigsResponse

Response to list 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

Request to list 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 Satellite imagery.
TERRAIN Terrain map type.
TERRAIN_DARK Темный вариант карты местности.
NAVIGATION Navigation map type.
NAVIGATION_LOW_LIGHT Вариант навигационной карты с низким уровнем освещенности.
TRANSIT Transit map type.
TRANSIT_DARK A dark version of the transit map type.
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 Unspecified visual feature.
FLATTEN_BUILDINGS Сносит все здания на карте.
ICONIC_ICONS Influences how icons are rendered.

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

What subset of the StyleConfig to return.

Перечисления
STYLE_CONFIG_VIEW_UNSPECIFIED Неуказанное мнение.
FULL Include the json_style_sheet in the response.
METADATA_ONLY Исключите элемент json_style_sheet из ответа.

UpdateMapConfigRequest

Request to update a MapConfig.

Поля
map_config

MapConfig

Required. The MapConfig to update.

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

update_mask

FieldMask

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

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

Request to update a 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

Request to update a StyleConfig.

Поля
style_config

StyleConfig

Required. The StyleConfig to update.

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

update_mask

FieldMask

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

  • display_name
  • description
  • json_style_sheet