索引
MapManagement(介面)CreateMapConfigRequest(訊息)CreateMapContextConfigRequest(訊息)CreateStyleConfigRequest(訊息)DeleteMapConfigRequest(訊息)DeleteMapContextConfigRequest(訊息)DeleteStyleConfigRequest(訊息)GetMapConfigRequest(訊息)GetMapContextConfigRequest(訊息)GetStyleConfigRequest(訊息)ListMapConfigsRequest(訊息)ListMapConfigsResponse(訊息)ListMapContextConfigsRequest(訊息)ListMapContextConfigsResponse(訊息)ListStyleConfigsRequest(訊息)ListStyleConfigsResponse(訊息)MapConfig(訊息)MapContextConfig(訊息)MapContextConfig.MapVariant(列舉)MapFeatures(訊息)MapFeatures.SimpleFeature(列舉)MapRenderingType(列舉)StyleConfig(訊息)StyleConfigView(列舉)UpdateMapConfigRequest(訊息)UpdateMapContextConfigRequest(訊息)UpdateStyleConfigRequest(訊息)
介面 MapManagement
Map Management API 的服務定義。
| 方法 | |
|---|---|
|
在專案中建立 MapConfig。 |
|
建立 MapContextConfig。 |
|
建立 StyleConfig。 |
|
刪除 MapConfig。 |
|
刪除 MapContextConfig。 |
|
刪除 StyleConfig。 |
|
取得 MapConfig。 |
|
取得 MapContextConfig。 |
|
取得 StyleConfig。 |
|
列出專案的 MapConfig。 |
|
列出 MapContextConfig。 |
|
列出 StyleConfig。 |
|
更新 MapConfig。 |
|
更新 MapContextConfig。 |
|
更新 StyleConfig。 |
CreateMapConfigRequest
要求建立 MapConfig。
| 欄位 | |
|---|---|
parent |
必填。擁有 MapConfig 的父項專案。格式: |
map_config |
必填。要建立的 MapConfig。 |
CreateMapContextConfigRequest
要求建立 MapContextConfig。
| 欄位 | |
|---|---|
parent |
必填。將擁有 MapContextConfig 的上層 MapConfig。格式: |
map_context_config |
必填。要建立的 MapContextConfig。 |
CreateStyleConfigRequest
要求建立 StyleConfig。
| 欄位 | |
|---|---|
parent |
必填。擁有 StyleConfig 的父項專案。格式: |
style_config |
必填。要建立的 StyleConfig。 |
DeleteMapConfigRequest
要求刪除 MapConfig。
| 欄位 | |
|---|---|
name |
必填。要刪除的 MapConfig 名稱。格式: |
DeleteMapContextConfigRequest
要求刪除 MapContextConfig。
| 欄位 | |
|---|---|
name |
必填。要刪除的 MapContextConfig 名稱。格式: |
DeleteStyleConfigRequest
要求刪除 StyleConfig。
| 欄位 | |
|---|---|
name |
必填。要刪除的 StyleConfig 名稱。格式: |
GetMapConfigRequest
要求取得 MapConfig。
| 欄位 | |
|---|---|
name |
必填。要擷取的 MapConfig 名稱。格式: |
GetMapContextConfigRequest
要求取得 MapContextConfig。
| 欄位 | |
|---|---|
name |
必填。要擷取的 MapContextConfig 名稱。格式: |
GetStyleConfigRequest
要求取得 StyleConfig。
| 欄位 | |
|---|---|
name |
必填。要擷取的 StyleConfig 名稱。格式: |
view |
(選用步驟) 要傳回的 StyleConfig 子集。如未設定,預設行為是傳回 FULL 檢視畫面。 |
ListMapConfigsRequest
要求列出專案的 MapConfig。
| 欄位 | |
|---|---|
parent |
必填。擁有 MapConfigs 的父項專案。格式: |
page_size |
(選用步驟) 要傳回的 MapConfig 數量上限。服務傳回的產品數量可能會少於這個值。如未指定,最多將傳回 50 個 MapConfig。許可的最大值為 1000;超出的數值將一律指定為 1000。目前不支援。 |
page_token |
(選用步驟) 屬於接收自前一個 進行分頁時,提供至 |
ListMapConfigsResponse
列出 MapConfig 的回應。
| 欄位 | |
|---|---|
map_configs[] |
MapConfig 清單。 |
next_page_token |
可做為 |
ListMapContextConfigsRequest
要求列出 MapContextConfigs。
| 欄位 | |
|---|---|
parent |
必填。擁有 MapContextConfigs 的上層 MapConfig。格式: |
page_size |
(選用步驟) 要傳回的 MapContextConfig 數量上限。服務傳回的產品數量可能會少於這個值。如未指定,最多將傳回 50 個 MapContextConfig。許可的最大值為 1000;超出的數值將一律指定為 1000。目前不支援。 |
page_token |
(選用步驟) 屬於接收自前一個 進行分頁時,提供至 |
ListMapContextConfigsResponse
列出 MapContextConfig 的回應。
| 欄位 | |
|---|---|
map_context_configs[] |
MapContextConfigs。 |
next_page_token |
可做為 |
ListStyleConfigsRequest
要求列出 StyleConfig。
| 欄位 | |
|---|---|
parent |
必填。擁有 StyleConfigs 的父項專案。格式: |
page_size |
(選用步驟) 要傳回的 StyleConfig 數量上限。服務傳回的產品數量可能會少於這個值。如未指定,最多將傳回 50 個 StyleConfig。許可的最大值為 1000;超出的數值將一律指定為 1000。目前不支援。 |
page_token |
(選用步驟) 屬於接收自前一個 進行分頁時,提供至 |
filter |
(選用步驟) ListStyleConfigs 呼叫的篩選運算式。目前僅支援依 display_name 篩選。舉例來說, |
view |
(選用步驟) 要傳回的 StyleConfig 子集。如未設定,預設行為是傳回 FULL 檢視畫面。 |
ListStyleConfigsResponse
列出 StyleConfig 的回應。
| 欄位 | |
|---|---|
style_configs[] |
StyleConfigs。 |
next_page_token |
可做為 |
MapConfig
代表 Maps API 用戶端應用程式中的單一地圖。MapConfig 是 MapContextConfigs 的上層資源,可在 SDK (行動版/網頁版) 中啟用自訂樣式。MapConfig 可以有多個 MapContextConfig,每個都會將樣式套用至特定地圖變體。Next ID = 9;
| 欄位 | |
|---|---|
name |
僅供輸出。ID。這個 MapConfig 的資源名稱。例如:「projects/my-project-123/mapConfigs/234」。僅供輸出。 |
display_name |
(選用步驟) 使用者指定的 MapConfig 顯示名稱。 |
description |
(選用步驟) 使用者指定的 MapConfig 說明。 |
map_id |
僅供輸出。這個 MapConfig 的地圖 ID,用於在用戶端應用程式中識別地圖。這個唯讀欄位會在建立 MapConfig 時產生。僅供輸出。 |
map_features |
(選用步驟) 適用於這項地圖設定的地圖功能。 |
map_type |
(選用步驟) 代表 MapConfig 的地圖類型。如未設定,預設行為是使用光柵地圖類型。 |
create_time |
僅供輸出。表示地圖設定的建立時間。僅供輸出。 |
update_time |
僅供輸出。表示地圖設定的上次更新時間。僅供輸出。 |
MapContextConfig
封裝地圖的樣式設定。MapContextConfig 會將樣式元件 (例如 StyleConfig 和 Datasets) 與 MapConfig 的特定地圖變體建立關聯。在 SDK 中載入 MapConfig 時,系統會將 MapContextConfig 中的樣式和資料集資訊套用至指定的地圖變體。Next ID = 10;
| 欄位 | |
|---|---|
name |
僅供輸出。ID。這個 MapContextConfig 的資源名稱。例如:projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id} |
map_config |
必填。這個 MapContextConfig 相關聯的 MapConfig 資源名稱。格式:projects/{project}/mapConfigs/{map_config}。這個欄位為必填欄位,不得省略。 |
style_config |
必填。為這個 MapContextConfig 設定樣式的 StyleConfig 資源名稱。這個欄位為必填欄位,不得省略。格式:projects/{project}/styleConfigs/{style_config} |
dataset[] |
(選用步驟) 與這個 MapContextConfig 相關聯的 Dataset 資源名稱。這是選填欄位,可以省略。如果省略,系統不會將任何資料集與 MapContextConfig 建立關聯。如果指定資料集,系統會將其套用至 MapContextConfig。格式:projects/{project}/datasets/{dataset} |
alias |
(選用步驟) 使用者定義的 MapContextConfig 人類可讀名稱。 |
map_variants[] |
必填。這個 MapContextConfig 可套用的地圖變體。如果為空白,系統只會將預設的 MapContextConfig 套用至 ROADMAP 地圖變體。 |
create_time |
僅供輸出。表示 MapContextConfig 的建立時間。僅供輸出。 |
update_time |
僅供輸出。表示 MapContextConfig 的上次更新時間。僅供輸出。 |
MapVariant
MapContextConfig 可套用的地圖變體。地圖變體分為淺色和深色變體。Light 變體無法與相同 MapContextConfig 的 Dark 變體配對。可用的淺色變體包括: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 繼承。Next ID = 3;
| 欄位 | |
|---|---|
simple_features[] |
(選用步驟) 要用於這張地圖的視覺功能。 |
poi_boost_level |
(選用步驟) POI 提升等級,其中 0 表示不提升,負值表示降低。如果搜尋點經過強化,系統會以較低的縮放比例顯示;如果搜尋點經過弱化,則會以較高的縮放比例顯示。目前支援 2 個升級層級,因此層級會限制在 [-2, 2]。如未指定,系統會使用樣式表定義的興趣點密度 (如有)。否則系統不會套用任何搜尋點密度。 |
SimpleFeature
這代表會影響地圖內在結構的一組地圖特徵。
| 列舉 | |
|---|---|
SIMPLE_FEATURE_UNSPECIFIED |
未指定視覺特徵。 |
FLATTEN_BUILDINGS |
將地圖中的所有建築物攤平。 |
ICONIC_ICONS |
影響圖示的顯示方式。 |
MapRenderingType
要算繪的地圖類型。如未指定,預設行為為 RASTER。
| 列舉 | |
|---|---|
RASTER |
使用以光柵為基礎的實作方式算繪的地圖。 |
VECTOR |
使用 WebGL 算繪的地圖。 |
StyleConfig
代表 Maps API 用戶端應用程式中的單一樣式。StyleConfig 包含定義地圖視覺外觀的 CSS 樣式表。Next ID = 9;
| 欄位 | |
|---|---|
name |
僅供輸出。ID。這個 StyleConfig 的資源名稱。例如:「projects/my-project-123/styleConfigs/234」。 |
display_name |
(選用步驟) 使用者指定的 StyleConfig 顯示名稱。 |
description |
(選用步驟) 使用者指定的 StyleConfig 說明。 |
style_id |
僅供輸出。這個樣式的專屬 ID。這是唯讀欄位,會在建立 StyleConfig 時產生。僅供輸出。 |
json_style_sheet |
(選用步驟) 這個 StyleConfig 的 CSS 樣式表 JSON 表示法。如未指定,系統會使用 Google 地圖的基本樣式。如要進一步瞭解可接受的 JSON 格式,請參閱 https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference。 |
create_time |
僅供輸出。表示 StyleConfig 的建立時間。 |
update_time |
僅供輸出。表示 StyleConfig 的上次更新時間。 |
StyleConfigView
要傳回的 StyleConfig 子集。
| 列舉 | |
|---|---|
STYLE_CONFIG_VIEW_UNSPECIFIED |
未指定檢視區塊。 |
FULL |
在回應中加入 json_style_sheet。 |
METADATA_ONLY |
從回應中排除 json_style_sheet。 |
UpdateMapConfigRequest
要求更新 MapConfig。
| 欄位 | |
|---|---|
map_config |
必填。要更新的 MapConfig。 MapConfig 的 |
update_mask |
(選用步驟) 要為 MapConfig 更新的特定欄位。如未指定,系統會更新整個 MapConfig。有效欄位包括:
|
UpdateMapContextConfigRequest
要求更新 MapContextConfig。
| 欄位 | |
|---|---|
map_context_config |
必填。要更新的 MapContextConfig。 MapContextConfig 的 |
update_mask |
(選用步驟) 要更新的欄位清單。如未指定,系統會更新整個 MapContextConfig。有效欄位包括:
|
UpdateStyleConfigRequest
要求更新 StyleConfig。
| 欄位 | |
|---|---|
style_config |
必填。要更新的 StyleConfig。 StyleConfig 的 |
update_mask |
(選用步驟) 要更新的欄位清單。如未指定,系統會更新整個 StyleConfig。有效欄位包括:
|