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

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

निर्देशों में यह माना गया है कि आपके पास Android IDE इंस्टॉल है और आपको Android डेवलपमेंट के बारे में जानकारी है.

नेविगेशन SDK टूल का इस्तेमाल करने के लिए ज़रूरी शर्तें

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

  • Google Cloud Console प्रोजेक्ट, जिसमें नेविगेशन SDK टूल चालू हो. प्रावधान करने के लिए, अपने Google Maps Platform प्रतिनिधि से संपर्क करें.

  • आपके ऐप्लिकेशन को Android के वर्शन इस तरह से तय करने होंगे:

    • टारगेट वर्शन Android 13 (एपीआई लेवल 33) या उसके बाद का होना चाहिए.
    • ऐप्लिकेशन का कम से कम वर्शन Android 6 (एपीआई लेवल 23) या उसके बाद का होना चाहिए.

  • नेविगेशन SDK के साथ बनाए गए किसी ऐप्लिकेशन को चलाने के लिए, Android डिवाइस को निम्न आवश्यकताएं पूरी करनी होंगी:

    • Google Play services को इंस्टॉल किया गया है और ये चालू हैं.

    • 2 जीबी या इससे ज़्यादा की रैम.

    • OpenGL ES 2.0 की सुविधा. 2D और 3D ग्राफ़िक एक्सेलरेशन के लिए Android ओपन सोर्स Android 6.0 कम्पैटिबिलिटी दस्तावेज़ देखें

  • ऐप्लिकेशन में एट्रिब्यूशन और लाइसेंसिंग टेक्स्ट जोड़ना ज़रूरी है.

अपने प्रोजेक्ट सेट अप करें: Cloud Console प्रोजेक्ट और Android प्रोजेक्ट

किसी ऐप्लिकेशन को बनाने या उसकी जांच करने से पहले, आपको एक Cloud Console प्रोजेक्ट बनाना होगा और एपीआई पासकोड के क्रेडेंशियल जोड़ने होंगे. प्रोजेक्ट में नेविगेशन SDK टूल को ऐक्सेस करने का प्रावधान होना चाहिए. Cloud Console प्रोजेक्ट में मौजूद सभी कुंजियों को नेविगेशन SDK टूल का एक ही ऐक्सेस दिया जाता है. किसी कुंजी से जुड़े एक से ज़्यादा डेवलपमेंट प्रोजेक्ट हो सकते हैं. अगर आपके पास पहले से ही कोई कंसोल प्रोजेक्ट है, तो अपने मौजूदा प्रोजेक्ट में कुंजी जोड़ी जा सकती है.

सेट अप करने के लिए

  1. अपने पसंदीदा वेब ब्राउज़र में, Cloud Console में साइन इन करें और अपना Cloud Console प्रोजेक्ट बनाएं.
  2. अपने IDE, जैसे कि Android Studio में, Android ऐप्लिकेशन डेवलपमेंट प्रोजेक्ट बनाएं और पैकेज का नाम नोट करें.
  3. अगर आपको अपने Cloud Console प्रोजेक्ट के लिए नेविगेशन SDK टूल का ऐक्सेस देना है, तो Google Maps Platform के प्रतिनिधि से संपर्क करें.
  4. अपने वेब ब्राउज़र में Cloud Console के डैशबोर्ड पर जाकर, पाबंदियों के साथ एपीआई पासकोड जनरेट करने के लिए क्रेडेंशियल बनाएं.
  5. एपीआई पासकोड पेज पर जाकर, ऐप्लिकेशन से जुड़ी पाबंदियां सेक्शन में जाकर Android ऐप्लिकेशन पर क्लिक करें.
  6. पैकेज का नाम और फ़िंगरप्रिंट जोड़ें पर क्लिक करें. इसके बाद, अपने डेवलपमेंट प्रोजेक्ट के पैकेज का नाम और उस कुंजी के लिए SHA-1 फ़िंगरप्रिंट डालें.
  7. सेव करें पर क्लिक करें.

अपने प्रोजेक्ट में नेविगेशन SDK टूल जोड़ना

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

यहां google() Maven रिपॉज़िटरी का इस्तेमाल किया गया है. यह आपके प्रोजेक्ट में नेविगेशन SDK टूल जोड़ने का सबसे आसान और सुझाया गया तरीका है.

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

    ग्रेडल

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

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

    अगर ओरिजनल Maven रिपॉज़िटरी से अपग्रेड किया जा रहा है, तो ध्यान दें कि ग्रुप और आर्टफ़ैक्ट के नाम बदल गए हैं. साथ ही, अब com.google.cloud.artifactregistry.gradle-plugin प्लगिन की ज़रूरत नहीं है.

    साथ ही, अपने टॉप-लेवल 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>com.google.android.libraries.navigation</groupId>
    <artifactId>navigation</artifactId>
    <version>VERSION_NUMBER</version>
  </dependency>
</dependencies>

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

    <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 बिल्ड स्क्रिप्ट अपडेट करना

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

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

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

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

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

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

    • अगर 'Android Gradle प्लग इन 4.0.0 या इसके बाद के वर्शन' का इस्तेमाल करके अपना ऐप्लिकेशन बनाया जा रहा है, तो यह प्लगिन, Java 8 लैंग्वेज एपीआई का इस्तेमाल करने पर काम करता है. ज़्यादा जानकारी के लिए, Java 8 डिज़ाइनिंग से जुड़ी सहायता देखें. बिल्ड स्क्रिप्ट स्निपेट का उदाहरण नीचे देखें. इससे आपको पता चलेगा कि कंपाइल और डिपेंडेंसी के विकल्प कैसे दिए जाते हैं.

नीचे, ऐप्लिकेशन के लिए 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 33
        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:1.1.9'
}

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

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

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

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

  1. Android Studio में, अपनी टॉप-लेवल build.gradle या build.gradle.kts फ़ाइल खोलें और 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.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}

    Kotlin

    plugins {
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}
  3. अपनी मॉड्यूल-लेवल build.gradle फ़ाइल में, पक्का करें कि targetSdk और compileSdk 34 पर सेट हों.
  4. फ़ाइल सेव करें और अपने प्रोजेक्ट को Gradle के साथ सिंक करें.
  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}" />

    Note: com.google.android.geo.API_KEY is the recommended metadata name for the API key. A key with this name can be used to authenticate to multiple Google Maps-based APIs on the Android platform, including the Navigation SDK for Android. For backwards compatibility, the API also supports the name com.google.android.maps.v2.API_KEY. This legacy name allows authentication to the Android Maps API v2 only. An application can specify only one of the API key metadata names. If both are specified, the API throws an exception.

  10. In Android Studio, open your module-level build.gradle or build.gradle.kts file and edit the secrets property. If the secrets property does not exist, add it.

    Edit the properties of the plugin to set propertiesFileName to secrets.properties, set defaultPropertiesFileName to local.defaults.properties, and set any other properties.

    Groovy

    secrets {
    // Optionally specify a different file name containing your secrets.
    // The plugin defaults to "local.properties"
    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.*"
}

    Kotlin

    secrets {
    // Optionally specify a different file name containing your secrets.
    // The plugin defaults to "local.properties"
    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) देखें.