अपना Android Studio प्रोजेक्ट सेट अप करना

इस पेज पर, डेवलपमेंट प्रोजेक्ट में Navigation SDK को इंटिग्रेट करने का तरीका बताया गया है.

अपने प्रोजेक्ट में Navigation SDK जोड़ना

Navigation SDK, Google Maven Repository के ज़रिए उपलब्ध है. अपने Gradle build.gradle या Maven pom.xml कॉन्फ़िगरेशन का इस्तेमाल करके, एसडीके को अपने प्रोजेक्ट में जोड़ा जा सकता है.

1. अपने Gradle या Maven कॉन्फ़िगरेशन में, यह डिपेंडेंसी जोड़ें. साथ ही, VERSION_NUMBER प्लेसहोल्डर को Android के लिए Navigation SDK के मनचाहे वर्शन से बदलें.

   Gradle

   अपने मॉड्यूल-लेवल build.gradle में यह जानकारी जोड़ें:

   dependencies {
           ...
           implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER'
   }
   

   Maven

   अपने pom.xml में यह जानकारी जोड़ें:

   <dependencies>
     ...
     <dependency>
       <groupId>com.google.android.libraries.navigation</groupId>
       <artifactId>navigation</artifactId>
       <version>VERSION_NUMBER</version>
     </dependency>
   </dependencies>
   

2. अगर आपके पास ऐसी कोई डिपेंडेंसी है जो Maps SDK का इस्तेमाल करती है, तो आपको हर उस डिपेंडेंसी को शामिल नहीं करना होगा जो Maps SDK पर निर्भर करती है.

   Gradle

   अपने टॉप-लेवल build.gradle में यह जानकारी जोड़ें:

   allprojects {
           ...
           // Required: you must exclude the Google Play service Maps SDK from
           // your transitive dependencies to make sure there won't be
           // multiple copies of Google Maps SDK in your binary, as the Navigation
           // SDK already bundles the Google Maps SDK.
           configurations {
               implementation {
                   exclude group: 'com.google.android.gms', module: 'play-services-maps'
               }
           }
   }
   

   Maven

   अपने pom.xml में यह जानकारी जोड़ें:

   <dependencies>
     <dependency>
     <groupId>project.that.brings.in.maps</groupId>
     <artifactId>MapsConsumer</artifactId>
     <version>1.0</version>
       <exclusions>
         <!-- Navigation SDK already bundles Maps SDK. You must exclude it to prevent duplication-->
         <exclusion>  <!-- declare the exclusion here -->
           <groupId>com.google.android.gms</groupId>
           <artifactId>play-services-maps</artifactId>
         </exclusion>
       </exclusions>
     </dependency>
   </dependencies>
   

बिल्ड को कॉन्फ़िगर करना

प्रोजेक्ट बनाने के बाद, सफल बिल्ड और Navigation SDK के इस्तेमाल के लिए सेटिंग कॉन्फ़िगर की जा सकती हैं.

स्थानीय प्रॉपर्टी अपडेट करना

• Gradle Scripts फ़ोल्डर में, local.properties फ़ाइल खोलें और android.useDeprecatedNdk=true जोड़ें.

Gradle बिल्ड स्क्रिप्ट अपडेट करना

• build.gradle (Module:app) फ़ाइल खोलें और सेटिंग को अपडेट करने के लिए, इन दिशा-निर्देशों का इस्तेमाल करें. इससे, सेटिंग को Navigation SDK की ज़रूरी शर्तों के मुताबिक बनाया जा सकेगा. साथ ही, ऑप्टिमाइज़ेशन के विकल्प भी सेट किए जा सकेंगे.

  Navigation SDK के लिए ज़रूरी सेटिंग

  1. minSdkVersion को 24 या इससे ज़्यादा पर सेट करें.
  2. targetSdkVersion को 36 या इससे ज़्यादा पर सेट करें.
  3. dexOptions सेटिंग जोड़ें, जिससे javaMaxHeapSize बढ़ जाता है.
  4. अतिरिक्त लाइब्रेरी के लिए जगह सेट करें.
  5. Navigation SDK के लिए, repositories और dependencies जोड़ें.
  6. डिपेंडेंसी में मौजूद वर्शन नंबर को, उपलब्ध नए वर्शन से बदलें.

  बिल्ड प्रोसेस में लगने वाला समय कम करने के लिए, वैकल्पिक सेटिंग

  • डिपेंडेंसी से, इस्तेमाल न होने वाले कोड और संसाधनों को हटाने के लिए, R8/ProGuard का इस्तेमाल करके, कोड छोटा करने और संसाधन छोटा करने की सुविधा चालू करें. अगर R8/ProGuard को चलने में ज़्यादा समय लगता है, तो डेवलपमेंट के काम के लिए, multidex की सुविधा चालू करने पर विचार करें.
  • बिल्ड में शामिल भाषा के अनुवादों की संख्या कम करें: डेवलपमेंट के दौरान, किसी एक भाषा के लिए resConfigs सेट करें. फ़ाइनल बिल्ड के लिए, उन भाषाओं के लिए resConfigs सेट करें जिनका असल में इस्तेमाल किया जाता है. डिफ़ॉल्ट रूप से, Gradle में उन सभी भाषाओं के लिए संसाधन स्ट्रिंग शामिल होती हैं जो Navigation SDK के साथ काम करती हैं.

  Java8 की सुविधा के लिए, desugaring जोड़ना

  • अगर अपने ऐप्लिकेशन को Android Gradle प्लग इन 4.0.0 या इसके बाद के वर्शन का इस्तेमाल करके बनाया जा रहा है, तो प्लग इन, Java 8 की भाषा के कई एपीआई इस्तेमाल करने की सुविधा देता है. ज़्यादा जानकारी के लिए, Java 8 desugaring की सुविधा देखें. कंपाइल और डिपेंडेंसी के विकल्पों के बारे में जानने के लिए, नीचे दिया गया बिल्ड स्क्रिप्ट स्निपेट देखें.
  • Android के 7.7.0 और इसके बाद के वर्शन के लिए, आपको Gradle 8.13, Android Gradle प्लग इन का 8.13.2 वर्शन, और Desugar लाइब्रेरी com.android.tools:desugar_jdk_libs_nio:2.1.5 का इस्तेमाल करना होगा.
  • Android के 7.3.0 से 7.6.0 वर्शन के लिए, आपको Gradle 8.11.1, Android Gradle प्लग इन का 8.10.0 वर्शन, और Desugar लाइब्रेरी com.android.tools:desugar_jdk_libs_nio:2.0.3 का इस्तेमाल करना होगा.
  • Desugar लाइब्रेरी को app मॉड्यूल और सीधे तौर पर Navigation SDK पर निर्भर करने वाले किसी भी मॉड्यूल के लिए चालू करना ज़रूरी है.

यहां ऐप्लिकेशन के लिए, Gradle बिल्ड स्क्रिप्ट का एक उदाहरण दिया गया है. डिपेंडेंसी के अपडेट किए गए सेट के लिए, सैंपल ऐप्लिकेशन देखें. ऐसा इसलिए, क्योंकि आपके इस्तेमाल किए जा रहे Navigation SDK का वर्शन, इस दस्तावेज़ में बताए गए वर्शन से थोड़ा आगे या पीछे हो सकता है.

apply plugin: 'com.android.application'

ext {
    navSdk = "__NAVSDK_VERSION__"
}

android {
    compileSdk 33
    buildToolsVersion='28.0.3'

    defaultConfig {
        applicationId "<your id>"
        // Navigation SDK supports SDK 23 and later.
        minSdkVersion 23
        targetSdkVersion 34
        versionCode 1
        versionName "1.0"
        // Set this to the languages you actually use, otherwise you'll include resource strings
        // for all languages supported by the Navigation SDK.
        resConfigs "en"
        multiDexEnabled true
    }

    dexOptions {
        // This increases the amount of memory available to the dexer. This is required to build
        // apps using the Navigation SDK.
        javaMaxHeapSize "4g"
    }
    buildTypes {
        // Run ProGuard. Note that the Navigation SDK includes its own ProGuard configuration.
        // The configuration is included transitively by depending on the Navigation SDK.
        // If the ProGuard step takes too long, consider enabling multidex for development work
        // instead.
        all {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        // Flag to enable support for the new language APIs
        coreLibraryDesugaringEnabled true
        // Sets Java compatibility to Java 8
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

repositories {
    // Navigation SDK for Android and other libraries are hosted on Google's Maven repository.
    google()
}

dependencies {
    // Include the Google Navigation SDK.
    // Note: remember to exclude Google Play service Maps SDK from your transitive
    // dependencies to avoid duplicate copies of the Google Maps SDK.
    api "com.google.android.libraries.navigation:navigation:${navSdk}"

    // Declare other dependencies for your app here.

    annotationProcessor "androidx.annotation:annotation:1.7.0"
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs_nio:2.1.5'
}

अपने ऐप्लिकेशन में एपीआई पासकोड जोड़ना

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

इस टास्क को आसान बनाने के लिए, हमारा सुझाव है कि आप Android के लिए Secrets Gradle प्लग इन का इस्तेमाल करें.

Android के लिए, Secrets Gradle प्लग इन इंस्टॉल करने और अपना एपीआई पासकोड सेव करने के लिए:

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

   Groovy

   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")
       }
   }

2. ऐप्लिकेशन-लेवल की build.gradle फ़ाइल खोलें और plugins एलिमेंट में यह कोड जोड़ें.

   Groovy

   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")
   }

3. अगर Android Studio का इस्तेमाल किया जा रहा है, तो अपने प्रोजेक्ट को Gradle के साथ सिंक करें.
4. अपने प्रोजेक्ट-लेवल की डायरेक्ट्री में मौजूद local.properties फ़ाइल खोलें. इसके बाद, यह कोड जोड़ें YOUR_API_KEY को अपने एपीआई पासकोड से बदलें.

   MAPS_API_KEY=YOUR_API_KEY

5. आपके पास AndroidManifest.xml फ़ाइल में एपीआई पासकोड जोड़ने या प्रोग्राम के ज़रिए एपीआई पासकोड देने का विकल्प होता है.
   • AndroidManifest.xml में अपना एपीआई पासकोड जोड़ना:

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

   • प्रोग्राम के ज़रिए एपीआई पासकोड देना:

     Secrets Gradle प्लग इन, BuildConfig क्लास में कुंजी उपलब्ध कराता है. अपने ऐप्लिकेशन के शुरू होने पर (उदाहरण के लिए, अपने Application.onCreate() तरीके में), इस तरीके को इस तरह कॉल करें:

     Kotlin

     1. इंपोर्ट करने के लिए, ये स्टेटमेंट जोड़ें:

        import com.google.android.libraries.navigation.NavigationApi

     2. अपने Application.onCreate() तरीके में यह जानकारी जोड़ें:

        NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY)

     Java

     1. इंपोर्ट करने के लिए, ये स्टेटमेंट जोड़ें:

        import com.google.android.libraries.navigation.NavigationApi;

     2. अपने Application.onCreate() तरीके में यह जानकारी जोड़ें:

        NavigationApi.setApiKey(BuildConfig.MAPS_API_KEY);

     ध्यान दें: setApiKey() का इस्तेमाल करते समय, इन बातों का ध्यान रखें:

     • कोई ऐसा एपीआई पासकोड दें जो खाली न हो और जिसमें कोई वैल्यू मौजूद हो.
     • अपने ऐप्लिकेशन के पूरे लाइफ़टाइम में, setApiKey() को सिर्फ़ एक बार कॉल करें. अगर इस तरीके को एक से ज़्यादा बार कॉल किया जाता है, तो यह IllegalStateException दिखाता है.
     • Navigator जैसे Navigation SDK के किसी भी कॉम्पोनेंट को शुरू करने से पहले, setApiKey() को कॉल करें.
     • इस तरीके से दी गई कुंजी, आपके AndroidManifest.xml में मौजूद किसी भी एपीआई पासकोड को बदल देती है.
     • Navigation SDK के 7.6 या इसके बाद के वर्शन का इस्तेमाल करें.

अपने ऐप्लिकेशन में, ज़रूरी एट्रिब्यूशन शामिल करना

अगर अपने ऐप्लिकेशन में, Android के लिए Navigation SDK का इस्तेमाल किया जाता है, तो आपको एट्रिब्यूशन टेक्स्ट और ओपन सोर्स लाइसेंस शामिल करने होंगे. इन्हें, अपने ऐप्लिकेशन के कानूनी नोटिस वाले सेक्शन में शामिल करें.

Android के लिए Navigation SDK की zip फ़ाइल में, ज़रूरी एट्रिब्यूशन टेक्स्ट और ओपन सोर्स लाइसेंस देखे जा सकते हैं:

• NOTICE.txt
• LICENSES.txt