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

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

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

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

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

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

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

    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. फ़ाइल सेव करें और Gredle के साथ प्रोजेक्ट सिंक करते हैं.
  5. अपनी शीर्ष-स्तरीय डायरेक्ट्री में secrets.properties फ़ाइल खोलें, और फिर जोड़ें . YOUR_API_KEY को अपनी एपीआई पासकोड से बदलें. अपनी कुंजी इस फ़ाइल में सेव करें ऐसा इसलिए हुआ, क्योंकि वर्शन कंट्रोल में secrets.properties की जांच नहीं की जा सकी सिस्टम.
    MAPS_API_KEY=YOUR_API_KEY
  6. फ़ाइल सेव करें.
  7. अपनी टॉप-लेवल डायरेक्ट्री में local.defaults.properties फ़ाइल बनाएं. फ़ोल्डर को secrets.properties फ़ाइल के रूप में चुनकर यह कोड जोड़ें.

    MAPS_API_KEY=DEFAULT_API_KEY

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

  8. फ़ाइल सेव करें.
  9. अपनी 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-आधारित एपीआई, जिनमें Android के लिए Maps SDK. पुराने सिस्टम के साथ काम करने की सुविधा के लिए, एपीआई com.google.android.maps.v2.API_KEY नाम का समर्थन करता है. यह लेगसी name सिर्फ़ Android Maps API v2 पर पुष्टि करने की अनुमति देता है. एक ऐप्लिकेशन ये काम कर सकता है: API कुंजी मेटाडेटा नामों में से केवल एक को दर्ज करें. अगर दोनों के बारे में बताया गया हो, तो एपीआई एक अपवाद देता है.

  10. 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"
    
        // Configure which keys should be ignored by the plugin by providing regular expressions.
        // "sdk.dir" is ignored by default.
        ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore"
        ignoreList.add("sdk.*")       // Ignore all keys matching the regexp "sdk.*"
    }
            

    ग्रूवी

    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"
    
        // Configure which keys should be ignored by the plugin by providing regular expressions.
        // "sdk.dir" is ignored by default.
        ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore"
        ignoreList.add("sdk.*")       // Ignore all keys matching the regexp "sdk.*"
    }
            

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