Package google.maps.mapmanagement.v2alpha

インデックス

MapManagement

Map Management API は、Cloud ベースのマップのスタイル設定リソース（MapConfigs、StyleConfigs、MapContextConfigs）に対する CRUD オペレーションをサポートしています。この 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)

MapContextConfigs を一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

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

rpc ListStyleConfigs(ListStyleConfigsRequest) returns (ListStyleConfigsResponse)

StyleConfig を一覧表示します。

認可スコープ

次の 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

必須。MapContextConfig を所有する親 MapConfig。形式: projects/{project}/mapConfigs/{map_config}
map_context_config

MapContextConfig

必須。作成する MapContextConfig。

CreateStyleConfigRequest

StyleConfig の作成リクエスト。

フィールド
parent

string

必須。StyleConfig を所有する親プロジェクト。形式: projects/{project}
style_config

StyleConfig

必須。作成する StyleConfig。

DeleteMapConfigRequest

MapConfig を削除するリクエスト。MapConfig に子 MapContextConfig がある場合、それらも削除されます。

フィールド
name

string

必須。削除する MapConfig のリソース名。形式: projects/{project}/mapConfigs/{map_config}
force

bool

省略可。true に設定すると、この MapConfig の MapContextConfigs も削除されます。（それ以外の場合、MapConfig に MapContextConfigs がない場合にのみリクエストが機能します）。

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

MapConfig のリストを取得するリクエスト。

フィールド
parent

string

必須。MapConfig を所有する親プロジェクト。形式: projects/{project}
page_size

int32

省略可。返す MapConfig の最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個の MapConfig が返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。現在サポートされていません。
page_token

string

省略可。前回の ListMapConfigs 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListMapConfigs に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。現在サポートされていません。

ListMapConfigsResponse

MapConfig のリスト取得リクエストに対するレスポンス。

フィールド
map_configs[]

MapConfig

MapConfig のリスト。
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。現在サポートされていません。

ListMapContextConfigsRequest

MapContextConfigs のリストを取得するリクエスト。

フィールド
parent

string

必須。MapContextConfigs を所有する親 MapConfig。形式: projects/{project}/mapConfigs/{map_config}
page_size

int32

省略可。返す MapContextConfigs の最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個の MapContextConfig が返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。現在サポートされていません。
page_token

string

省略可。前回の ListMapContextConfigs 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListMapContextConfigs に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。現在サポートされていません。

ListMapContextConfigsResponse

MapContextConfigs のリスト取得に対するレスポンス。

フィールド
map_context_configs[]

MapContextConfig

MapContextConfigs。
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。現在サポートされていません。

ListStyleConfigsRequest

StyleConfig のリストを取得するリクエスト。

フィールド
parent

string

必須。StyleConfigs を所有する親プロジェクト。形式: projects/{project}
page_size

int32

省略可。返す StyleConfigs の最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合は、最大で 50 個の StyleConfig が返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。現在サポートされていません。
page_token

string

省略可。前回の ListStyleConfigs 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListStyleConfigs に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。現在サポートされていません。
filter

string

省略可。ListStyleConfigs 呼び出しのフィルタ式。現在、display_name によるフィルタリングのみがサポートされています。たとえば、display_name="My StyleConfig" は、表示名が「My StyleConfig」のすべての StyleConfig を返します。
view

StyleConfigView

省略可。返す StyleConfig のサブセット。設定されていない場合、デフォルトの動作は FULL ビューを返すことです。

ListStyleConfigsResponse

StyleConfigs のリスト取得に対するレスポンス。

フィールド
style_configs[]

StyleConfig

StyleConfigs。
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。現在サポートされていません。

MapConfig

Maps API クライアント アプリケーション内の単一の地図を表します。MapConfig は MapContextConfigs の親リソースであり、SDK（モバイル/ウェブ）でカスタム スタイリングを有効にします。MapConfig には複数の MapContextConfig を含めることができ、それぞれが特定の地図バリアントにスタイルを適用します。Next ID = 9;

フィールド
name

string

出力専用。ID。この MapConfig のリソース名。例: 「projects/my-project-123/mapConfigs/234」。出力専用。
display_name

string

省略可。ユーザーが指定したこの MapConfig の表示名。
description

string

省略可。ユーザーが指定したこの MapConfig の説明。
map_id

string

出力専用。この MapConfig のマップ ID。クライアント アプリケーションでマップを識別するために使用されます。この読み取り専用フィールドは、MapConfig の作成時に生成されます。出力専用。
map_features

MapFeatures

省略可。このマップ構成に適用されるマップ対象物。
map_type

MapRenderingType

省略可。MapConfig のマップタイプを表します。設定されていない場合、デフォルトの動作はラスターマップタイプを使用することです。
create_time

Timestamp

出力専用。マップ構成の作成日時を示します。出力専用。
update_time

Timestamp

出力専用。マップ構成の最終更新日時を示します。出力専用。

MapContextConfig

地図のスタイル設定をカプセル化します。MapContextConfig は、StyleConfig や Datasets などのスタイリング コンポーネントを MapConfig の特定のマップ バリアントに関連付けます。MapConfig が SDK に読み込まれると、MapContextConfig のスタイル設定とデータセット情報が指定された地図バリアントに適用されます。次の ID = 10;

フィールド
name

string

出力専用。ID。この MapContextConfig のリソース名。例: projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id}
map_config

string

必須。この MapContextConfig が関連付けられている MapConfig リソース名。形式: projects/{project}/mapConfigs/{map_config}。このフィールドは必須であり、省略できません。
style_config

string

必須。この MapContextConfig のスタイル設定を行う StyleConfig リソース名。このフィールドは必須であり、省略できません。形式: projects/{project}/styleConfigs/{style_config}
dataset[]

string

省略可。この MapContextConfig に関連付けられている Dataset リソース名。このフィールドは省略可能です。省略すると、データセットは 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 で Light バリアントと 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 Photorealistic 3D Maps の地図タイプ。

MapFeatures

MapConfig に適用される地図対象物のコレクションを表します。MapConfig で設定された機能は、すべての子 MapContextConfig に継承されます。Next ID = 3;

フィールド
simple_features[]

SimpleFeature

省略可。この地図に使用するビジュアル機能。
poi_boost_level

int32

省略可。POI ブースト レベル。0 はブーストなし、負の値はデブーストを示します。ブーストされたスポットは、デフォルトよりも低いズームレベルで表示されます。ブーストされていないスポットは、デフォルトよりも高いズームレベルで表示されます。現在、2 レベルのブーストがサポートされているため、レベルは [-2, 2] にクランプされます。指定しない場合、スタイルシートで定義された POI 密度が存在すれば、それが使用されます。それ以外の場合、POI 密度は適用されません。

SimpleFeature

これは、地図の固有の構造に影響する地図のフィーチャーのセットを表します。

列挙型
SIMPLE_FEATURE_UNSPECIFIED 視覚的特徴が指定されていません。
FLATTEN_BUILDINGS 地図上のすべての建物を平らにします。
ICONIC_ICONS アイコンのレンダリング方法に影響します。

MapRenderingType

レンダリングする地図のタイプ。指定しない場合、デフォルトの動作は RASTER です。

列挙型
RASTER ラスターベースの実装を使用してレンダリングされた地図。
VECTOR WebGL を使用してレンダリングされた地図。

StyleConfig

Maps API クライアント アプリケーションの単一のスタイルを表します。StyleConfig には、地図の視覚的な外観を定義するスタイルシートが含まれています。Next ID = 9;

フィールド
name

string

出力専用。ID。この StyleConfig のリソース名。例: 「projects/my-project-123/styleConfigs/234」。
display_name

string

省略可。ユーザーが指定したこの StyleConfig の表示名。
description

string

省略可。ユーザーが指定したこの StyleConfig の説明。
style_id

string

出力専用。このスタイルの固有識別子。StyleConfig の作成時に生成される読み取り専用のフィールドです。出力専用。
json_style_sheet

string

省略可。この StyleConfig のスタイルシートの JSON 表現。指定しない場合は、ベースの 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。

MapConfig の name フィールドは、更新する MapConfig を識別するために使用されます。形式: projects/{project}/mapConfigs/{map_config}
update_mask

FieldMask

省略可。MapConfig で更新する特定のフィールド。指定しない場合、MapConfig は全体が更新されます。有効なフィールドは次のとおりです。

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

MapContextConfig の更新リクエスト。

フィールド
map_context_config

MapContextConfig

必須。更新する MapContextConfig。

MapContextConfig の name フィールドは、更新する 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

必須。更新する StyleConfig。

StyleConfig の name フィールドは、更新する StyleConfig を識別するために使用されます。形式: projects/{project}/styleConfigs/{style_config}
update_mask

FieldMask

省略可。更新するフィールドのリスト。指定しない場合、StyleConfig は全体が更新されます。有効なフィールドは次のとおりです。

  • display_name
  • description
  • json_style_sheet