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

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

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

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

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

   ग्रेडल

   मॉड्यूल-लेवल की 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 पर निर्भर हर डिपेंडेंसी में उस डिपेंडेंसी को शामिल नहीं करना होगा.

   ग्रेडल

   अपनी टॉप-लेवल 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 के साथ काम करने के लिए, डिसुगरिंग की सुविधा जोड़ी गई

  • अगर Android Gradle प्लगिन 4.0.0 या इसके बाद के वर्शन का इस्तेमाल करके ऐप्लिकेशन बनाया जा रहा है, तो प्लगिन, Java 8 भाषा के कई एपीआई इस्तेमाल करने की सुविधा देता है. ज़्यादा जानकारी के लिए, Java 8 के साथ काम करने वाले desugaring की सुविधा देखें. कंपाइल और डिपेंडेंसी के विकल्पों के बारे में जानने के लिए, यहां उदाहरण के तौर पर दी गई बिल्ड स्क्रिप्ट का स्निपेट देखें.
  • Gradle, Android Gradle प्लगिन (AGP), और Desugar लाइब्रेरी के उन वर्शन का इस्तेमाल करें जो आपके Navigation SDK के वर्शन से मेल खाते हों. यहां दी गई टेबल देखें.
  • Desugar लाइब्रेरी को app मॉड्यूल और Navigation SDK पर सीधे तौर पर निर्भर करने वाले किसी भी मॉड्यूल के लिए चालू करना ज़रूरी है.

यहां दी गई टेबल में, Gradle, AGP, और Desugar लाइब्रेरी के उन वर्शन की सूची दी गई है जो 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 के लिए सीक्रेट ग्रेडल प्लग इन का इस्तेमाल करें.

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

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

2. ऐप्लिकेशन-लेवल की 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")
   }

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 Plugin, 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 दिखाता है.
     • setApiKey() को कॉल करने से पहले, Navigation SDK के किसी दूसरे कॉम्पोनेंट को शुरू न करें. जैसे, Navigator.
     • इस तरीके से दी गई कुंजी, आपके AndroidManifest.xml में मौजूद किसी भी एपीआई पासकोड को बदल देती है.
     • Navigation SDK के 7.6 या इसके बाद के वर्शन का इस्तेमाल करें.

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

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

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

• NOTICE.txt
• LICENSES.txt