[Google Maps Datasets API(V1)] Javaで地理空間データを利用する

Google Maps Datasets API(V1)をJavaで使ってみました。
今回の記事はAPIを利用するにあたり準備する必要があるものを記事にしました。

Maps Datasets APIとは
独自の地理空間データをデータセットにアップロードし、
データ対象物にカスタムスタイル設定を適用して地図に表示できます。

点、ポリライン、ポリゴンのジオメトリに基づいてデータを可視化したり、
データ対象物をクリックイベントに反応させたりできます。

No			目次
1			Maps Datasets APIを使用するための準備
	1		プロジェクトの作成
	2		Maps Datasets APIの設定
	3		APIを使用するためのキー取得
		1	サービス アカウント
		2	OAuth2.0 クライアントID
2			権限付与
3			Maps Datasets APIを使ってみる
	1		googleライブラリの読み込み
	2		MapsPlatformDatasetsClientインスタンスを取得
		1	サービスアカウントを利用する場合
		2	OAuth 2.0 クライアントIDを利用する場合
	3		プログラムの実行
4			いろいろとAPIを叩いてみる
	1		v1.media
	2		v1.projects.datasets

1. Maps Datasets APIを使用するための準備

設定は下記から行います。
⧉Google クラウド プラットフォーム

1. GCPプロジェクトの作成
2. Maps Datasets APIの設定
3. プログラムで使用するキーの取得

1.1. プロジェクトの作成

まずはGCPでプロジェクトを作成します。
詳細はこちらの記事を参照ください
⧉[Google Sheets API] Google Sheets API v4をJavaで操作する(1.1. プロジェクトの作成)

1.2. Maps Datasets APIの設定

Maps Datasets APIを使えるようにします。

No	手順
1	メニューの 「APIとサービス」 -> 「ライブラリ」 を選択します。
2	Maps datasetsと入力して「Maps Datasets API」を検索します。
3	「有効にする」ボタンを押して「Maps Datasets API」を使用可能にします。

1.3. APIを使用するためのキー取得

プログラムからAPIを実行するための準備を行います。
サービスアカウント、OAuth2.0、APIキーを利用する3つの方法があります。

1.3.1. サービス アカウント

同じ内容を下記の記事に掲載してますので、下記の記事を参照ください。
⧉[Google Sheets API] Google Sheets API v4をJavaで操作する(1.3. Googleサービスアカウントの作成)

1.3.2. OAuth2.0 クライアントID

同じ内容を下記の記事に掲載してますので、下記の記事を参照ください。
⧉[Google Drive API v3] JavaでDrive APIを使う(1.3.2. OAuth2.0 クライアントID)

2. 権限付与

APIを使用してアクセスするにはプロジェクト単位での権限の付与が必須です。

APIをいろいろと叩く予定なので、ロールに「Maps API管理者」を指定していますが、
状況に応じて適切に設定してください。

No	手順
1	メニュー「IAMと管理」 -> 「IAM」を選択します。
2	「アクセス権を付与」を選択します。
3	下記を入力・設定して「保存」ボタンを押します。 新しいプリンシパル：サービスアカウントメールアドレスか、OAuth2.0認証を行うメールアドレス ロールを選択：Maps API管理者

3. Maps Datasets APIを使ってみる

3.1. googleライブラリの読み込み

Maps Datasets APIを使用するためにライブラリのパスを設定します。
私の環境はpom.xmlで下記を指定しています。
Javaのバージョンは21を使用しています。

<dependencies>
    <dependency>
        <groupId>com.google.api-client</groupId>
        <artifactId>google-api-client</artifactId>
    </dependency>
    <dependency>
        <groupId>com.google.maps</groupId>
        <artifactId>google-maps-mapsplatformdatasets</artifactId>
        <version>0.31.0</version>
    </dependency>
    <!-- OAuth2.0でAPIを使う場合は下記を追加してください。 -->
    <dependency>
        <groupId>com.google.oauth-client</groupId>
        <artifactId>google-oauth-client-jetty</artifactId>
    </dependency>
</dependencies>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.google.cloud</groupId>
            <artifactId>libraries-bom</artifactId>
            <version>26.38.0</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

3.2. MapsPlatformDatasetsClientインスタンスを取得

3.2.1. サービスアカウントを利用する場合

コード中の「JSONファイルのパス」は、
⧉[Google Sheets API] Google Sheets API v4をJavaで操作する(1.3. Googleサービスアカウントの作成)
で取得したJSONファイルのパスを指定してください。

private static MapsPlatformDatasetsClient getMapsPlatformDatasetsClient() throws Exception{
    try(InputStream input = new FileInputStream("JSONファイルのパス")){
        GoogleCredentials credentials = GoogleCredentials
                .fromStream(input)
                .createScoped(Arrays.asList("https://www.googleapis.com/auth/cloud-platform"));
        
        MapsPlatformDatasetsSettings settings = MapsPlatformDatasetsSettings.newBuilder()
                .setCredentialsProvider(FixedCredentialsProvider.create(credentials)) 
                .build();
        
        return MapsPlatformDatasetsClient.create(settings);
    }
}

3.2.2. OAuth 2.0 クライアントIDを利用する場合

コード中の「JSONファイルのパス」は、
⧉[Google Drive API v3] JavaでDrive APIを使う(1.3.2.1 認証情報の作成)
で取得したJSONファイルのパスを指定してください。

コード中の「認証情報を保存するフォルダパス」は、
認証情報が保存されるフォルダのパスを指定してください。
このコードを実行するとOAuth同意画面が表示されます。
ユーザーが同意をすると認証情報を保存するフォルダにファイルが生成されます。
このファイルが存在した場合は、再度実行してもOAuth同意画面は表示されません。

private static MapsPlatformDatasetsClient getMapsPlatformDatasetsClient2() throws Exception{
    HttpTransport transport = GoogleNetHttpTransport.newTrustedTransport();
    GsonFactory jsonFactory = GsonFactory.getDefaultInstance();
    
    try(Reader reader = new InputStreamReader(new FileInputStream("JSONファイルのパス"))){
        GoogleClientSecrets clientSecrets = GoogleClientSecrets.load(jsonFactory,reader);
        
        GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder(
                transport, jsonFactory, clientSecrets, 
                Arrays.asList("https://www.googleapis.com/auth/cloud-platform"))
            .setDataStoreFactory(new FileDataStoreFactory(new java.io.File("認証情報を保存するフォルダパス")))
            .build();
        
        LocalServerReceiver receiver = new LocalServerReceiver.Builder().build();
        Credential credential = new AuthorizationCodeInstalledApp(flow, receiver).authorize("user");
        UserCredentials credentials = UserCredentials.newBuilder()
                .setClientId(clientSecrets.getDetails().getClientId())
                .setClientSecret(clientSecrets.getDetails().getClientSecret())
                .setRefreshToken(credential.getRefreshToken())
                .build();

        MapsPlatformDatasetsSettings settings = MapsPlatformDatasetsSettings.newBuilder()
                .setCredentialsProvider(FixedCredentialsProvider.create(credentials))
                .build();
       
        return MapsPlatformDatasetsClient.create(settings);
    }
}

3.3. プログラムの実行

プログラムを動かします。

サンプルはデータセット一覧を取得しています。

public static void main(String[] args) throws Exception{
    try(MapsPlatformDatasetsClient client = getMapsPlatformDatasetsClient()){
        ListDatasetsRequest.Builder builder = ListDatasetsRequest.newBuilder();
        builder.setParent(String.format("projects/%s", "プロジェクトID"));
        
        MapsPlatformDatasetsClient.ListDatasetsPagedResponse response = client.listDatasets(builder.build());
        for(Dataset dataset : response.iterateAll()) {
            System.out.println(dataset);
        }
    }
}

4. いろいろとAPIを叩いてみる

いろいろとAPIを叩いてみます。

4.1. v1.media

メディアアップロード、ダウンロードの操作

メソッド	概要	記事
download	データセットをダウンロード	Java非対応(2024年5月 時点)
upload	データセットをアップロード	Java非対応(2024年5月 時点)

4.2. v1.projects.datasets

データセットに関する操作

メソッド	概要	記事
create	データセットを作成	⧉[Google Maps Datasets API(V1)] Javaで地理空間データのデータセットを作成・更新・削除する
delete	データセットを削除	⧉[Google Maps Datasets API(V1)] Javaで地理空間データのデータセットを作成・更新・削除する
get	データセットを取得	⧉[Google Maps Datasets API(V1)] Javaで地理空間データのデータセットを取得する
list	データセット一覧を取得	⧉[Google Maps Datasets API(V1)] Javaで地理空間データのデータセットを取得する
patch	データセットを更新	⧉[Google Maps Datasets API(V1)] Javaで地理空間データのデータセットを作成・更新・削除する

おしまい。。