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

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

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

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

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

    ग्रेडल

    अपने मॉड्यूल-लेवल 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. This is to ensure 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>

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

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

लोकल प्रॉपर्टी अपडेट करना

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

Gradle की प्रॉपर्टी अपडेट करना

  • Gradle स्क्रिप्ट फ़ोल्डर में, gradle.properties फ़ाइल खोलें. अगर ये पहले से मौजूद नहीं हैं, तो इन्हें जोड़ें:

    1. android.useAndroidX=true
    2. android.enableJetifier=true

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

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

    नेविगेशन SDK टूल के लिए ज़रूरी सेटिंग

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

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

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

    Java8 से जुड़ी सहायता के लिए सेटिंग जोड़ना

    • अगर 'Android Gradle प्लग इन 4.0.0 या इसके बाद के वर्शन' का इस्तेमाल करके अपना ऐप्लिकेशन बनाया जा रहा है, तो यह प्लगिन, Java 8 लैंग्वेज एपीआई का इस्तेमाल करने पर काम करता है. ज़्यादा जानकारी के लिए, Java 8 वर्शन डिज़ाइन करने से जुड़ी सहायता देखें. उदाहरण के तौर पर, नीचे दी गई स्क्रिप्ट का स्निपेट देखें. इसमें, कॉम्पाइल करने और डिपेंडेंसी के विकल्पों के बारे में बताया गया है.
    • हमारा सुझाव है कि आप Gradle 8.4, Android Gradle प्लग इन के 8.3.0 वर्शन, और Desugar लाइब्रेरी com.android.tools:desugar_jdk_libs_nio:2.0.3 का इस्तेमाल करें. यह सेटअप Android के 6.0.0 और इसके बाद के वर्शन के लिए बने नेविगेशन SDK टूल के साथ काम करता है.
    • app मॉड्यूल के लिए और ऐसे किसी भी मॉड्यूल के लिए Desugar लाइब्रेरी चालू करनी होगी जो सीधे तौर पर नेविगेशन SDK पर निर्भर करता है.

नीचे, ऐप्लिकेशन के लिए Gradle बिल्ड स्क्रिप्ट का एक उदाहरण दिया गया है. डिपेंडेंसी के अपडेट किए गए सेट के बारे में जानने के लिए, ऐप्लिकेशन के सैंपल देखें. इसकी वजह यह है कि इस्तेमाल किए जा रहे नेविगेशन 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.0.3'
}

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

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

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

अपने 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 को वर्शन कंट्रोल सिस्टम में शामिल नहीं किया जाता. 
    NAV_API_KEY=YOUR_API_KEY
  6. फ़ाइल सेव करें.

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

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

  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.*"
}

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

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

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

  • NOTICE.txt
  • LICENSES.txt

अगर आप मोबिलिटी या फ़्लीट इंजन डिलीवरी के ग्राहक हैं

अगर आप मोबिलिटी या फ़्लीट इंजन डिलीवरी के ग्राहक हैं, तो मोबिलिटी दस्तावेज़ में बिलिंग के बारे में जानें. लेन-देन रिकॉर्ड करने के बारे में ज़्यादा जानकारी के लिए, बिलिंग सेट अप करना, बिल किए गए लेन-देन रिकॉर्ड करना, रिपोर्टिंग, और बिल करने लायक लेन-देन रिकॉर्ड करना (Android) देखें.