सैन फ़्रांसिस्को में दिसंबर में होने वाले, Google Maps Platform डेवलपर कम्यूनिटी डे में हमारे साथ शामिल हों! अभी आवेदन करें.

Google आपकी पसंदीदा भाषा में कॉन्टेंट का अनुवाद करने के लिए, एआई टेक्नोलॉजी का इस्तेमाल करता है. एआई से मिले अनुवादों में गलतियां हो सकती हैं.

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

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

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

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

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

अगर आपके पास ऐसी डिपेंडेंसी हैं जो 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 को रन होने में बहुत ज़्यादा समय लगता है, तो डेवलपमेंट के काम के लिए मल्टीडेक्स को चालू करें.
- बिल्ड में शामिल अनुवादों की संख्या कम करें: डेवलपमेंट के दौरान, एक भाषा के लिए resConfigs सेट करें. फ़ाइनल बिल्ड के लिए, resConfigs को उन भाषाओं के लिए सेट करें जिनका इस्तेमाल किया जाता है. डिफ़ॉल्ट रूप से, Gradle में उन सभी भाषाओं के लिए रिसॉर्स स्ट्रिंग शामिल होती हैं जो Navigation SDK के साथ काम करती हैं.
Java8 के साथ काम करने के लिए, डिशुगरिंग की सुविधा जोड़ना
- अगर Android Gradle प्लग इन 4.0.0 या इसके बाद के वर्शन का इस्तेमाल करके ऐप्लिकेशन बनाया जा रहा है, तो प्लग इन कई Java 8 लैंग्वेज एपीआई इस्तेमाल करने की सुविधा देता है. ज़्यादा जानकारी के लिए, Java 8 के लिए डिशुगरिंग की सुविधा देखें. कंपाइल और डिपेंडेंसी के विकल्पों के बारे में जानने के लिए, नीचे दिया गया बिल्ड स्क्रिप्ट स्निपेट देखें.
- Gradle, Android Gradle प्लगिन (एजीपी), और Desugar लाइब्रेरी के ऐसे वर्शन इस्तेमाल करें जो आपके Navigation SDK के वर्शन के साथ काम करते हों. नीचे दी गई टेबल देखें.
- app मॉड्यूल और Navigation SDK पर सीधे तौर पर निर्भर करने वाले किसी भी मॉड्यूल के लिए, Desugar लाइब्रेरी को चालू करना ज़रूरी है.

यहां दी गई टेबल में, Navigation SDK के हर वर्शन के लिए ज़रूरी Gradle, AGP, और Desugar लाइब्रेरी के वर्शन की सूची दी गई है.

Navigation SDK का वर्शन	Gradle वर्शन	AGP का वर्शन	डीशुगर लाइब्रेरी
8.0.0 और इसके बाद के वर्शन	9.1.0	9.0.1	`com.android.tools:desugar_jdk_libs_nio:2.1.5`
7.7.0 से 7.9.0	8.13	8.13.2	`com.android.tools:desugar_jdk_libs_nio:2.1.5`
7.3.0 से 7.6.0	8.11.1	8.10.0	`com.android.tools:desugar_jdk_libs_nio:2.0.3`

यहां ऐप्लिकेशन के लिए, 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 फ़ाइल में सेव करें और उस फ़ाइल को वर्शन कंट्रोल से बाहर रखें. Gradle प्रॉपर्टी फ़ाइलों के बारे में ज़्यादा जानने के लिए, Gradle प्रॉपर्टी फ़ाइलें देखें.

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

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

Android Studio में, अपनी टॉप-लेवल build.gradle.kts या build.gradle फ़ाइल खोलें और plugins ब्लॉक में यह कोड जोड़ें.

Kotlin

plugins {
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") version "2.0.1" apply false
}

ग्रूवी

plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' version '2.0.1' apply false
}

मॉड्यूल-लेवल की build.gradle.kts या build.gradle फ़ाइल खोलें और plugins एलिमेंट में यह कोड जोड़ें.

Kotlin

plugins {
    id("com.android.application")
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}

ग्रूवी

plugins {
    id 'com.android.application'
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}

अगर Android Studio का इस्तेमाल किया जा रहा है, तो अपने प्रोजेक्ट को Gradle के साथ सिंक करें.
अपनी टॉप-लेवल डायरेक्ट्री में secrets.properties फ़ाइल खोलें. इसके बाद, यह कोड जोड़ें. YOUR_API_KEY को अपने एपीआई पासकोड से बदलें. secrets.properties को अपनी .gitignore फ़ाइल में जोड़ना न भूलें. इसके अलावा, इसे अपने वर्शन कंट्रोल सिस्टम से बाहर रखें, ताकि आप वर्शन कंट्रोल में अपना एपीआई पासकोड न डालें.
ध्यान दें: अगर secrets.properties फ़ाइल मौजूद नहीं है, तो उसे उसी फ़ोल्डर में बनाएं जिसमें local.properties फ़ाइल मौजूद है.
```
MAPS_API_KEY=YOUR_API_KEY
```
अपनी टॉप-लेवल डायरेक्ट्री में local.defaults.properties फ़ाइल बनाएं. यह वही फ़ोल्डर होना चाहिए जिसमें secrets.properties फ़ाइल है. इसके बाद, यह कोड जोड़ें.

ध्यान दें: कोड को ठीक उसी तरह डालें जैसा वह दिख रहा है. DEFAULT_API_KEY को अपने एपीआई पासकोड से न बदलें.
```
MAPS_API_KEY=DEFAULT_API_KEY
```
इस फ़ाइल का मकसद, एपीआई पासकोड के लिए बैकअप लोकेशन उपलब्ध कराना है. ऐसा तब किया जाता है, जब secrets.properties फ़ाइल न मिले, ताकि बिल्ड फ़ेल न हों. ऐसा तब हो सकता है, जब आपने ऐप्लिकेशन को किसी ऐसे वर्शन कंट्रोल सिस्टम से क्लोन किया हो जिसमें secrets.properties शामिल न हो और आपने अब तक अपने एपीआई पासकोड को उपलब्ध कराने के लिए, डिवाइस पर secrets.properties फ़ाइल न बनाई हो.
एपीआई पासकोड को अपनी 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 पर आधारित कई एपीआई की पुष्टि करने के लिए किया जा सकता है. इनमें Navigation SDK for Android भी शामिल है. पुराने सिस्टम के साथ काम करने की सुविधा के लिए, एपीआई में com.google.android.maps.v2.API_KEY नाम का भी इस्तेमाल किया जा सकता है. इस लेगसी नाम की मदद से, सिर्फ़ Android Maps API v2 की पुष्टि की जा सकती है. कोई ऐप्लिकेशन, एपीआई पासकोड के मेटाडेटा के नामों में से सिर्फ़ एक नाम तय कर सकता है. अगर दोनों एट्रिब्यूट की वैल्यू दी जाती हैं, तो एपीआई एक अपवाद दिखाता है.
- प्रोग्राम के हिसाब से एपीआई पासकोड दें:
  सीक्रेट ग्रेडल प्लग इन, कुंजी को 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 दिखाता है.
  - Navigation SDK के किसी अन्य कॉम्पोनेंट, जैसे कि Navigator को शुरू करने से पहले, setApiKey() को कॉल करें.
  - इस तरीके से दिया गया पासकोड, आपके AndroidManifest.xml में मौजूद किसी भी एपीआई पासकोड को बदल देता है.
  - Navigation SDK के 7.6 या इसके बाद के वर्शन का इस्तेमाल करें.

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 root directory (the same folder as the root 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 root directory (the same folder as the root 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 की ZIP फ़ाइल में, ज़रूरी एट्रिब्यूशन टेक्स्ट और ओपन सोर्स लाइसेंस मिल सकते हैं:

NOTICE.txt
LICENSES.txt

अगर आप मोबिलिटी या Fleet Engine Deliveries के ग्राहक हैं

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

मैन्युअल डिपेंडेंसी (नॉन-Gradle/Maven)

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

androidx.datastore:datastore-core
androidx.datastore:datastore-guava
com.google.guava:listenablefuture
androidx.concurrent:concurrent-futures