इस पेज पर, Navigation SDK को अपने डेवलपमेंट प्रोजेक्ट में इंटिग्रेट करने का तरीका बताया गया है.
अपने प्रोजेक्ट में Navigation SDK जोड़ना
Navigation SDK, Google
Maven
Repository के ज़रिए उपलब्ध है.
अपने प्रोजेक्ट में एसडीके को Gradle build.gradle या Maven pom.xml कॉन्फ़िगरेशन का इस्तेमाल करके जोड़ा जा सकता है.
अपने 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>अगर आपकी कोई ऐसी डिपेंडेंसी है जो 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 के लिए ज़रूरी सेटिंग
minSdkVersionको 23 या इससे ज़्यादा पर सेट करें.targetSdkVersionको 34 या इससे ज़्यादा पर सेट करें.- ऐसी
dexOptionsसेटिंग जोड़ें जिससेjavaMaxHeapSizeबढ़ जाए. - अतिरिक्त लाइब्रेरी के लिए जगह सेट करें.
- Navigation SDK के लिए
repositoriesऔरdependenciesजोड़ें. - डिपेंडेंसी में मौजूद वर्शन नंबर को, उपलब्ध नए वर्शन से बदलें.
बिल्ड टाइम को कम करने के लिए वैकल्पिक सेटिंग
- डिपेंडेंसी से इस्तेमाल न होने वाले कोड और संसाधनों को हटाने के लिए, R8/ProGuard का इस्तेमाल करके कोड और संसाधन छोटा करने की सुविधा चालू करें. अगर R8/ProGuard को चलने में बहुत ज़्यादा समय लगता है, तो डेवलपमेंट के काम के लिए multidex को चालू करें.
- बिल्ड में शामिल किए गए भाषा अनुवादों की संख्या कम करें: डेवलपमेंट के दौरान, एक भाषा के लिए
resConfigsसेट करें. फ़ाइनल बिल्ड के लिए, उन भाषाओं के लिएresConfigsसेट करें जिनका इस्तेमाल किया जाता है. Gradle, डिफ़ॉल्ट रूप से उन सभी भाषाओं के लिए संसाधन स्ट्रिंग शामिल करता है जिनमें Navigation 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 के लिए Navigation SDK के 6.0.0 और इसके बाद के वर्शन के साथ काम करता है. appमॉड्यूल और Navigation SDK पर सीधे तौर पर निर्भर करने वाले किसी भी मॉड्यूल के लिए, Desugar लाइब्रेरी को चालू करना ज़रूरी है.
यहां ऐप्लिकेशन के लिए 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 के लिए सीक्रेट ग्रेडल प्लग इन का इस्तेमाल करें.
Android के लिए Secrets Gradle Plugin इंस्टॉल करने और अपनी एपीआई कुंजी सेव करने के लिए:
-
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") } }
-
ऐप्लिकेशन-लेवल की
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") }
- अगर Android Studio का इस्तेमाल किया जाता है, तो अपने प्रोजेक्ट को Gradle के साथ सिंक करें.
-
अपने प्रोजेक्ट लेवल की डायरेक्ट्री में मौजूद
local.propertiesखोलें. इसके बाद, यह कोड जोड़ें.YOUR_API_KEYको अपने एपीआई पासकोड से बदलें.MAPS_API_KEY=YOUR_API_KEY
-
अपनी
AndroidManifest.xmlफ़ाइल में,com.google.android.geo.API_KEYपर जाएं औरandroid:valueएट्रिब्यूट को इस तरह अपडेट करें:<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 के लिए नेविगेशन एसडीके भी शामिल है. पुराने सिस्टम के साथ काम करने की सुविधा के लिए, एपीआईcom.google.android.maps.v2.API_KEYनाम का इस्तेमाल भी किया जा सकता है. इस लेगसी नाम से, सिर्फ़ Android Maps API v2 की पुष्टि की जा सकती है. कोई ऐप्लिकेशन, एपीआई कुंजी के मेटाडेटा के सिर्फ़ एक नाम के बारे में बता सकता है. अगर दोनों को तय किया जाता है, तो API एक अपवाद दिखाता है.
अपने ऐप्लिकेशन में ज़रूरी एट्रिब्यूशन शामिल करना
अगर आपने अपने ऐप्लिकेशन में Navigation SDK for Android का इस्तेमाल किया है, तो आपको अपने ऐप्लिकेशन के कानूनी सूचनाओं वाले सेक्शन में एट्रिब्यूशन टेक्स्ट और ओपन सोर्स लाइसेंस शामिल करने होंगे.
आपको ज़रूरी एट्रिब्यूशन टेक्स्ट और ओपन सोर्स लाइसेंस, Android के लिए Navigation SDK टूल की ज़िप फ़ाइल में मिल सकते हैं:
NOTICE.txtLICENSES.txt
अगर आप Mobility या Fleet Engine Deliveries के ग्राहक हैं
अगर आप Mobility या Fleet Engine Deliveries के ग्राहक हैं, तो Mobility के दस्तावेज़ में बिलिंग के बारे में जानें. लेन-देन रिकॉर्ड करने के बारे में ज़्यादा जानने के लिए, बिलिंग सेट अप करना, बिल किए जा सकने वाले लेन-देन रिकॉर्ड करना, रिपोर्टिंग, और बिल किए जा सकने वाले लेन-देन रिकॉर्ड करना (Android) लेख पढ़ें.