Google का सुझाव है कि आप अपनी एपीआई कुंजी को वर्शन कंट्रोल सिस्टम में शामिल न करें. इसके बजाय, आपको इसे लोकल secrets.properties फ़ाइल में सेव करना चाहिए. यह फ़ाइल आपके प्रोजेक्ट की रूट डायरेक्ट्री में मौजूद होती है, लेकिन इसे वर्शन कंट्रोल से बाहर रखा जाता है. इसके बाद, एपीआई पासकोड को पढ़ने के लिए, Android के लिए Secrets Gradle Plugin का इस्तेमाल करें.
Android के लिए Secrets Gradle Plugin, सीक्रेट पढ़ता है. इनमें एपीआई पासकोड भी शामिल है. यह सीक्रेट, ऐसी प्रॉपर्टी फ़ाइल से पढ़ा जाता है जिसे वर्शन कंट्रोल सिस्टम में चेक इन नहीं किया गया है. इसके बाद, प्लग इन उन प्रॉपर्टी को Gradle से जनरेट की गई BuildConfig क्लास और Android मेनिफ़ेस्ट फ़ाइल में वैरिएबल के तौर पर दिखाता है.
एपीआई पासकोड को ऐक्सेस करने के लिए, Android के लिए Secrets Gradle Plugin का इस्तेमाल करने का पूरा उदाहरण देखने के लिए, Android Studio प्रोजेक्ट सेट अप करना लेख पढ़ें.
इंस्टॉल करना और इस्तेमाल करना
Android के लिए Secrets Gradle Plugin इंस्टॉल करने और अपनी एपीआई कुंजी सेव करने के लिए:
-
Android Studio में, अपनी रूट-लेवल की
build.gradleफ़ाइल खोलें. इसके बाद,buildscriptमें मौजूदdependenciesएलिमेंट में यह कोड जोड़ें.ग्रूवी
buildscript { dependencies { // ... classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1" } }
Kotlin
buildscript { dependencies { // ... classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1") } }
-
ऐप्लिकेशन-लेवल की
build.gradleफ़ाइल खोलें औरpluginsएलिमेंट में यह कोड जोड़ें.ग्रूवी
plugins { id 'com.android.application' // ... id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' }
Kotlin
plugins { id("com.android.application") // ... id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") }
- अगर Android Studio का इस्तेमाल किया जाता है, तो अपने प्रोजेक्ट को Gradle के साथ सिंक करें.
-
अपने प्रोजेक्ट लेवल की डायरेक्ट्री में मौजूद
local.propertiesखोलें. इसके बाद, यह कोड जोड़ें.YOUR_API_KEYको अपने एपीआई पासकोड से बदलें.MAPS_API_KEY=YOUR_API_KEY
-
अपनी
AndroidManifest.xmlफ़ाइल में,com.google.android.geo.API_KEYपर जाएं औरandroid:valueएट्रिब्यूट को इस तरह अपडेट करें:<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 के लिए पुष्टि की जा सकती है. कोई ऐप्लिकेशन, एपीआई कुंजी के मेटाडेटा के सिर्फ़ एक नाम के बारे में बता सकता है. अगर दोनों को तय किया जाता है, तो एपीआई एक अपवाद दिखाता है.
आगे क्या करना है
- Android के लिए सीक्रेट ग्रेडल प्लग इन का GitHub प्रोजेक्ट पेज देखें.
- प्लगिन इस्तेमाल करने का पूरा उदाहरण देखने के लिए, Android Studio प्रोजेक्ट सेट अप करना लेख पढ़ें.