अपना 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 को 23 या इससे ज़्यादा पर सेट करें.
    2. targetSdkVersion को 34 या इससे ज़्यादा पर सेट करें.
    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 8.4, Android Gradle प्लग इन 8.3.0, और Desugar लाइब्रेरी com.android.tools:desugar_jdk_libs_nio:2.0.3 का इस्तेमाल करें. यह सेटअप, Android के लिए Navigation SDK के 6.0.0 और इसके बाद के वर्शन के साथ काम करता है.
    • 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.0.3'
}

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

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

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

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

  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 को वर्शन कंट्रोल सिस्टम में शामिल नहीं किया जाता. 
    MAPS_API_KEY=YOUR_API_KEY

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

    MAPS_API_KEY=DEFAULT_API_KEY

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

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

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

    ग्रूवी

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

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

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

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

  • NOTICE.txt
  • LICENSES.txt

अगर आप Mobility या Fleet Engine Deliveries के ग्राहक हैं

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