सीक्रेट ग्रेडल प्लग इन

Google का सुझाव है कि आप अपने वर्शन कंट्रोल सिस्टम में एपीआई पासकोड को शामिल न करें. इसके बजाय, आपको इसे किसी लोकल secrets.properties फ़ाइल में सेव करना चाहिए. यह फ़ाइल, आपके प्रोजेक्ट की रूट डायरेक्ट्री में होती है, लेकिन इसे वर्शन कंट्रोल से बाहर रखा जाता है. इसके बाद, एपीआई कुंजी को पढ़ने के लिए, Android के लिए Secrets Gradle प्लग इन का इस्तेमाल करें.

Android के लिए Secrets Gradle प्लग इन, एपीआई पासकोड के साथ-साथ ऐसी प्रॉपर्टी फ़ाइल से सीक्रेट पढ़ता है जिसे वर्शन कंट्रोल सिस्टम में चेक नहीं किया गया है. इसके बाद, प्लग इन उन प्रॉपर्टी को ग्रेडल से जनरेट की गई BuildConfig क्लास और Android मेनिफ़ेस्ट फ़ाइल में वैरिएबल के तौर पर दिखाता है.

एपीआई पासकोड ऐक्सेस करने के लिए, Android के लिए Secrets Gradle प्लग इन का इस्तेमाल करने का पूरा उदाहरण देखने के लिए, Android Studio प्रोजेक्ट सेट अप करना लेख पढ़ें.

इंस्टॉलेशन और इस्तेमाल

अपने Google Maps प्रोजेक्ट में, Android के लिए Secrets Gradle प्लग इन इंस्टॉल करने के लिए:

  1. Android Studio में, अपनी टॉप-लेवल build.gradle.kts या build.gradle फ़ाइल खोलें और buildscript में मौजूद dependencies एलिमेंट में यह कोड जोड़ें.

    Kotlin

    buildscript {
    dependencies {
        classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
    }
}

    ग्रूवी

    buildscript {
    dependencies {
        classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
    }
}
  2. मॉड्यूल-लेवल की build.gradle.kts या build.gradle फ़ाइल खोलें और plugins एलिमेंट में यह कोड जोड़ें.

    Kotlin

    plugins {
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}

    ग्रूवी

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}
  3. मॉड्यूल-लेवल की build.gradle.kts या build.gradle फ़ाइल में, पक्का करें कि targetSdk और compileSdk को 34 पर सेट किया गया हो.
  4. अपने प्रोजेक्ट को Gradle के साथ सिंक करें.
  5. अपनी टॉप-लेवल डायरेक्ट्री में secrets.properties फ़ाइल खोलें. इसके बाद, यहां दिया गया कोड जोड़ें. YOUR_API_KEY को अपनी एपीआई पासकोड से बदलें. अपनी कुंजी को इस फ़ाइल में सेव करें, क्योंकि secrets.properties को वर्शन कंट्रोल सिस्टम में शामिल नहीं किया जाता. 
    MAPS_API_KEY=YOUR_API_KEY

  6. अपनी टॉप-लेवल डायरेक्ट्री में local.defaults.properties फ़ाइल बनाएं. यह फ़ाइल, secrets.properties फ़ाइल के उसी फ़ोल्डर में होनी चाहिए. इसके बाद, नीचे दिया गया कोड जोड़ें.

    MAPS_API_KEY=DEFAULT_API_KEY

    इस फ़ाइल का मकसद, एपीआई पासकोड का बैकअप सेव करना है. ऐसा इसलिए किया जाता है, ताकि अगर secrets.properties फ़ाइल न मिले, तो भी बिल्ड न रुके. ऐसा तब हो सकता है, जब आपने ऐप्लिकेशन को किसी ऐसे वर्शन कंट्रोल सिस्टम से क्लोन किया हो जिसमें secrets.properties शामिल न हो और आपने एपीआई पासकोड देने के लिए, अब तक लोकल तौर पर secrets.properties फ़ाइल न बनाई हो.

  7. अपनी AndroidManifest.xml फ़ाइल में, com.google.android.geo.API_KEY पर जाएं और android:value attribute को अपडेट करें. अगर <meta-data> टैग मौजूद नहीं है, तो इसे <application> टैग के चाइल्ड के तौर पर बनाएं. 
    <meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />

    ध्यान दें: com.google.android.geo.API_KEY, एपीआई पासकोड के लिए सुझाया गया मेटाडेटा नाम है. इस नाम वाली कुंजी का इस्तेमाल, Android प्लैटफ़ॉर्म पर कई Google Maps-आधारित एपीआई की पुष्टि करने के लिए किया जा सकता है. इनमें Maps SDK for Android भी शामिल है. पुराने सिस्टम के साथ काम करने की सुविधा के लिए, एपीआई में com.google.android.maps.v2.API_KEY नाम भी काम करता है. इस लेगसी नाम का इस्तेमाल करके, सिर्फ़ Android Maps API v2 की पुष्टि की जा सकती है. कोई ऐप्लिकेशन, एपीआई पासकोड के मेटाडेटा के सिर्फ़ एक नाम का इस्तेमाल कर सकता है. अगर दोनों एट्रिब्यूट की वैल्यू दी गई है, तो एपीआई एक अपवाद दिखाता है.

  8. Android Studio में, अपने मॉड्यूल-लेवल की build.gradle.kts या build.gradle फ़ाइल खोलें और secrets प्रॉपर्टी में बदलाव करें. अगर secrets प्रॉपर्टी मौजूद नहीं है, तो उसे जोड़ें.

    propertiesFileName को secrets.properties पर सेट करने के लिए, प्लग इन की प्रॉपर्टी में बदलाव करें. साथ ही, defaultPropertiesFileName को local.defaults.properties पर सेट करें और कोई अन्य प्रॉपर्टी सेट करें.

    Kotlin

    secrets {
    // To add your Maps API key to this project:
    // 1. If the secrets.properties file does not exist, create it in the same folder as the local.properties file.
    // 2. Add this line, where YOUR_API_KEY is your API key:
    //        MAPS_API_KEY=YOUR_API_KEY
    propertiesFileName = "secrets.properties"

    // A properties file containing default secret values. This file can be
    // checked in version control.
    defaultPropertiesFileName = "local.defaults.properties"
}

    ग्रूवी

    secrets {
    // To add your Maps API key to this project:
    // 1. If the secrets.properties file does not exist, create it in the same folder as the local.properties file.
    // 2. Add this line, where YOUR_API_KEY is your API key:
    //        MAPS_API_KEY=YOUR_API_KEY
    propertiesFileName = "secrets.properties"

    // A properties file containing default secret values. This file can be
    // checked in version control.
    defaultPropertiesFileName = "local.defaults.properties"
}

आगे क्या करना है