How to use gradle to replace Google Maps API key?

Question

I use one among many options to store my API keys in the computer/keychain rather than directly in the cloud-backed-up project code (namely gradle-credentials-plugin ). What I'd like is to be able to manage Google Maps keys in a similar way, but they're used in a different file (Manage Google Maps API Key with Gradle in Android Studio).

If anyone has a simple (or intricate, but reliable) option for me to dig into, I'd be grateful!

Answer 1

You can use manifestPlaceholders to inject the string from your build.gradle.

1. Inset your API key into a file like local.properties

google.maps_api_key=SECRET_KEY

2. Make sure this file is ignored using .gitignore:

local.properties

3. Make the API key available to your AndroidManifest.xml. Using withInputStream() ensures the InputStream is closed automatically.

android{
  defaultConfig {

    // Load credentials.
    def properties = new Properties()
    file("../local.properties").withInputStream { properties.load(it) }

    // Share the key with your `AndroidManifest.xml`
    manifestPlaceholders = [ googleMapsApiKey:"${properties.getProperty('google.maps_api_key')}"]

4. Load the API key in your AndroidManifest.xml:

<application>

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