Setup

This page describes what you need to do to get set up to start building with the Maps 3D SDK for Android. The setup process involves configuring a Google Cloud project and API for use with the SDK, and then setting up an Android Studio project. Complete these steps before adding your first 3D map to your app .

Set up a Google Cloud project and API key

Before you can start building with the Maps 3D SDK for Android, you need to set up a Google Cloud project and API key to use with the Maps 3D SDK for Android by completing the following steps:

gcloud  
projects  
create  
 " PROJECT 
" 

gcloud  
services  
 enable 
  
 \ 
  
--project  
 " PROJECT 
" 
  
 \ 
  
 "addressvalidation.googleapis.com" 
  
 \ 
  
 "areainsights.googleapis.com" 
  
 \ 
  
 "tile.googleapis.com" 
  
 \ 
  
 "aerialview.googleapis.com" 
  
 \ 
  
 "elevation-backend.googleapis.com" 
  
 \ 
  
 "routes.googleapis.com" 
  
 \ 
  
 "geocoding-backend.googleapis.com" 
  
 \ 
  
 "geolocation.googleapis.com" 
  
 \ 
  
 "maps-android-backend.googleapis.com" 
  
 \ 
  
 "maps-backend.googleapis.com" 
  
 \ 
  
 "maps-embed-backend.googleapis.com" 
  
 \ 
  
 "maps-ios-backend.googleapis.com" 
  
 \ 
  
 "mapsplatformdatasets.googleapis.com" 
  
 \ 
  
 "places-backend.googleapis.com" 
  
 \ 
  
 "roads.googleapis.com" 
  
 \ 
  
 "routeoptimization.googleapis.com" 
  
 \ 
  
 "static-maps-backend.googleapis.com" 
  
 \ 
  
 "street-view-image-backend.googleapis.com" 
  
 \ 
  
 "timezone-backend.googleapis.com" 

gcloud  
services  
 enable 
  
 \ 
  
--project  
 " PROJECT 
" 
  
 \ 
  
 "airquality.googleapis.com" 
  
 \ 
  
 "solar.googleapis.com" 
  
 \ 
  
 "pollen.googleapis.com" 
  
 \ 
  
 "weather.googleapis.com" 

gcloud  
services  
api-keys  
create  
 \ 
  
--project  
 " PROJECT 
" 
  
 \ 
  
--display-name  
 " DISPLAY_NAME 
" 

To enable the SDK, see the Maps 3D SDK for Android page in the Google Cloud console. For more information about completing these steps, see Getting started with the Google Maps Platform .

Set up an Android Studio project

This section explains how to create and configure an Android Studio project for use with the Maps 3D SDK for Android.

Part 1: Set up your project and Gradle configuration

1. Create a new Android Studio project using the Empty Views Activitytemplate.

2. If you are using Git for source control, modify the project .gitignore file to prevent your secrets file from being committed to version control:

   • In your project's root directory, open the .gitignore file.
   • Add the following line:

    secrets.properties 
   

3. Update the project-level build.gradle.kts file:

   • In your project's root directory, open the build.gradle.kts file.
   • In the plugins block, add the Secrets Gradle plugin:

     plugins 
     
    { 
     
    alias 
    ( 
    libs 
    . 
    plugins 
    . 
    android 
    . 
    application 
    ) 
     
    apply 
     
    false 
     
    alias 
    ( 
    libs 
    . 
    plugins 
    . 
    kotlin 
    . 
    android 
    ) 
     
    apply 
     
    false 
     
     alias 
    ( 
    libs 
    . 
    plugins 
    . 
    secrets 
    . 
    gradle 
    . 
    plugin 
    ) 
     
    apply 
     
    false 
     
    // Add this line 
    } 
    
   

4. Update the gradle/libs.versions.toml file: - Open the gradle/libs.versions.toml file, which is usually located in the gradle directory within the project root directory. - In the versions section, add the versions for the SDK and Secrets Gradle plugin:

     maps3dSdk 
     
    = 
     
    "0.0.1" 
     
    # Update this value to match the SDK version to include 
    secretsGradlePlugin 
     
    = 
     
    "2.0.1" 
    
   

     - 
     
    In 
     
    the 
     
    library 
     
    section 
    , 
     
    add 
     
    the 
     
    SDK 
     
    library 
    : 
    
   

     play-services-maps3d 
     
    = 
     
    { 
     
    module 
     
    = 
     
    "com.google.android.gms:play-services-maps3d" 
    , 
     
    version 
    . 
    ref 
     
    = 
     
    "maps3dSdk" 
     
    } 
    
   

    -   In the plugin section, add the Secrets Gradle plugin: 
   

     secrets-gradle-plugin 
     
    = 
     
    { 
     
    id 
     
    = 
     
    "com.google.android.libraries.mapsplatform.secrets-gradle-plugin" 
    , 
     
    version 
    . 
    ref 
     
    = 
     
    "secretsGradlePlugin" 
     
    } 
    
   

5. Update the module-level app/build.gradle.kts file: - Open the module-level build.gradle.kts file, which is usually located within the app directory. - At the top of the file, add the Secrets Gradle plugin to the plugins block:

     plugins 
     
    { 
     
    alias 
    ( 
    libs 
    . 
    plugins 
    . 
    android 
    . 
    application 
    ) 
     
    alias 
    ( 
    libs 
    . 
    plugins 
    . 
    kotlin 
    . 
    android 
    ) 
     
     alias 
    ( 
    libs 
    . 
    plugins 
    . 
    secrets 
    . 
    gradle 
    . 
    plugin 
    ) 
     
    // Add this line 
    } 
    
   

     - 
     
    In 
     
    the 
     
    `dependencies` 
     
    block 
    , 
     
    add 
     
    the 
     
    SDK 
    : 
    
   

     dependencies 
     
    { 
     
    // ... other dependencies 
     
     implementation 
    ( 
    libs 
    . 
    play 
    . 
    services 
    . 
    maps3d 
    ) 
     
    // Add this line 
    } 
    
   

     - 
     
    At 
     
    the 
     
    end 
     
    of 
     
    the 
     
    file 
    , 
     
    outside 
     
    of 
     
    the 
     
    `android` 
     
    and 
     
    `dependencies` 
     
    blocks 
    , 
     
    add 
     
    the 
     
    secrets 
     
    configuration 
    : 
    
   

     secrets 
     
    { 
     
    // Optionally specify a different filename containing your secrets. 
     
    // The plugin defaults to "local.properties" 
     
    propertiesFileName 
     
    = 
     
    "secrets.properties" 
     
    // A properties file containing default secret values. This file can be 
     
    // checked in version control. 
     
    defaultPropertiesFileName 
     
    = 
     
    "local.defaults.properties" 
    } 
    
   

Part 2: Add your API key to your project

1. Create a secrets.properties file:

   • In the app module root directory (usually the app directory), create a new file named secrets.properties .
   • Add your API key to the file:

     MAPS3D_API_KEY 
    = 
    YOUR_API_KEY_HERE 
    ``` 
     
    Note: Make sure you 
     
    replace 
     
    `YOUR_API_KEY_HERE` with the API key that you configured for use 
    with 
     
    the Maps 3D SDK for Android. 
    
   

2. Create a local.defaults.properties file: - In the app module root directory, create a new file named secrets.properties . - Add a default or placeholder API key to the file. This file can be checked into version control:

     MAPS3D_API_KEY 
    = 
    DEFAULT_API_KEY_OR_PLACEHOLDER 
    
   

Part 3: Update your AndroidManifest.xml file

1. Open the app/src/main/AndroidManifest.xml file.

2. Inside the <application> tag, before the <activity> tag, add the following <meta-data> element to declare your API key:

    <application  
   ...>  
    <meta-data  
   android:name="com.google.android.geo.maps3d.API_KEY"  
   android:value="${MAPS3D_API_KEY}"  
   />  
   <activity  
   ...>  
   </activity>
   </application> 
   

   During the build process, the Secrets Gradle Plugin will replace the ${MAPS3D_API_KEY} placeholder with the key from your secrets.properties file.

Next steps

Now that you have a Google Cloud project, API key, and an Android Studio project set up for use with the Maps 3D SDK for Android, you can Add a 3D map to your app .