इस गाइड में, Android के लिए Navigation SDK टूल का इस्तेमाल करने के लिए, बिल्ड कॉन्फ़िगरेशन की ज़रूरी शर्तों के बारे में बताया गया है. यहां दिए गए निर्देशों का पालन करने के लिए, आपके पास Android IDE इंस्टॉल होना चाहिए. साथ ही, आपको Android डेवलपमेंट के बारे में जानकारी होनी चाहिए.
Navigation SDK का इस्तेमाल करने के लिए ज़रूरी शर्तें
ये ज़रूरी शर्तें, Android के लिए Navigation SDK टूल के 4.99 और इससे पहले के वर्शन पर लागू होती हैं.
-
प्रोजेक्ट में Navigation SDK चालू होना चाहिए. प्रोविज़निंग के लिए, Google Maps Platform के प्रतिनिधि से संपर्क करें.
आपके ऐप्लिकेशन को एपीआई लेवल 30 या उसके बाद के लेवल को टारगेट करना होगा.
Navigation SDK की मदद से बनाए गए ऐप्लिकेशन को चलाने के लिए, Android डिवाइस पर Google Play services इंस्टॉल और चालू होनी चाहिए.
ऐप्लिकेशन में एट्रिब्यूशन और लाइसेंसिंग टेक्स्ट जोड़ना ज़रूरी है.
अपने प्रोजेक्ट सेट अप करें: Cloud Console प्रोजेक्ट और Android प्रोजेक्ट
ऐप्लिकेशन बनाने या उसकी जांच करने से पहले, आपको Cloud Console प्रोजेक्ट बनाना होगा. साथ ही, एपीआई कुंजी के क्रेडेंशियल जोड़ने होंगे. Navigation SDK को ऐक्सेस करने के लिए, प्रोजेक्ट में प्रोविज़निंग होनी चाहिए. Cloud Console प्रोजेक्ट में मौजूद सभी कुंजियों को Navigation SDK का एक जैसा ऐक्सेस दिया जाता है. किसी कुंजी से एक से ज़्यादा डेवलपमेंट प्रोजेक्ट जुड़े हो सकते हैं. अगर आपके पास पहले से कोई कंसोल प्रोजेक्ट है, तो अपने मौजूदा प्रोजेक्ट में एक कुंजी जोड़ी जा सकती है.
सेट अप करने के लिए
- अपने पसंदीदा वेब ब्राउज़र में, Cloud Console में साइन इन करें और अपना Cloud Console प्रोजेक्ट बनाएं.
- Android Studio जैसे IDE में, Android ऐप्लिकेशन डेवलपमेंट प्रोजेक्ट बनाएं और पैकेज का नाम नोट करें.
- अपने Google Maps Platform प्रतिनिधि से संपर्क करें, ताकि वह आपके Cloud Console प्रोजेक्ट के लिए Navigation SDK का ऐक्सेस दे सके.
- अपने वेब ब्राउज़र में Cloud Console डैशबोर्ड पर जाकर, पाबंदियों के साथ एपीआई पासकोड जनरेट करने के लिए क्रेडेंशियल बनाएं.
- एपीआई पासकोड पेज पर, ऐप्लिकेशन से जुड़ी पाबंदियां सेक्शन में जाकर, Android ऐप्लिकेशन पर क्लिक करें.
- पैकेज का नाम और फ़िंगरप्रिंट जोड़ें पर क्लिक करें. इसके बाद, अपने डेवलपमेंट प्रोजेक्ट का पैकेज नाम और उस कुंजी के लिए SHA-1 फ़िंगरप्रिंट डालें.
- सेव करें पर क्लिक करें.
अपने प्रोजेक्ट में Navigation SDK जोड़ना
Navigation SDK, Maven का इस्तेमाल करके या AAR बंडल के तौर पर उपलब्ध है. डेवलपमेंट प्रोजेक्ट बनाने के बाद, SDK टूल को इसमें इंटिग्रेट किया जा सकता है. इसके लिए, इनमें से कोई एक तरीका इस्तेमाल करें.
Navigation SDK v4.5 और इसके बाद के वर्शन के लिए Maven का इस्तेमाल करना (सुझाया गया)
नीचे दिए गए तरीके में google()
Maven रिपॉज़िटरी का इस्तेमाल किया गया है. यह आपके प्रोजेक्ट में Navigation SDK जोड़ने का सबसे आसान और सुझाया गया तरीका है
अपने Gradle या Maven कॉन्फ़िगरेशन में यह डिपेंडेंसी जोड़ें. साथ ही,
VERSION_NUMBER
प्लेसहोल्डर को Android के लिए Navigation SDK के वर्शन से बदलें.ग्रेडल
अपने मॉड्यूल-लेवल
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 to make nsure 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>
Navigation SDK के 4.5 से पहले के वर्शन या Driver SDK के साथ Maven का इस्तेमाल करना
Navigation SDK, Maven के ओरिजनल रिपॉज़िटरी का इस्तेमाल करके उपलब्ध रहेगा. यह सुविधा, v4 के बाकी वर्शन में भी उपलब्ध रहेगी. यह ऊपर दिए गए वर्शन वाली लाइब्रेरी ही है. इसमें वही अपडेट शामिल हैं. साथ ही, यह ट्रांज़िशन के दौरान Driver SDK और अन्य लाइब्रेरी के साथ काम करती है.
इस डिपेंडेंसी का इस्तेमाल करने के लिए, कंपाइल करते समय gcloud
का इस्तेमाल करके अपने क्लाउड प्रोजेक्ट में लॉग इन करना ज़रूरी है.
- Google की Maven रिपॉज़िटरी को ऐक्सेस करने के लिए, अपना एनवायरमेंट सेट अप करें. इसके लिए, Consumer SDK के दस्तावेज़ के ज़रूरी शर्तें सेक्शन में दी गई जानकारी देखें. Navigation SDK का ऐक्सेस, वर्कस्पेस ग्रुप के ज़रिए कंट्रोल किया जाता है.
अपने Gradle या Maven कॉन्फ़िगरेशन में यह डिपेंडेंसी जोड़ें. साथ ही,
VERSION_NUMBER
प्लेसहोल्डर की जगह Navigation SDK का वर्शन डालें.ग्रेडल
अपने मॉड्यूल-लेवल
build.gradle
में यह जोड़ें:dependencies { ... implementation 'com.google.android.maps:navsdk:VERSION_NUMBER' }
इसके बाद, टॉप-लेवल
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>com.google.android.maps</groupId> <artifactId>navsdk</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>
डाउनलोड किए गए AAR बंडल का इस्तेमाल करें (हम इसका सुझाव नहीं देते)
Navigation SDK, AAR बंडल के तौर पर भी उपलब्ध है. डेवलपमेंट प्रोजेक्ट बनाने के बाद, SDK को इंटिग्रेट किया जा सकता है. इन निर्देशों में, IDE के तौर पर Android Studio का इस्तेमाल करने के बारे में बताया गया है.
शेयर किए गए Google Drive से, Navigation SDK का नया वर्शन डाउनलोड करें और उसे एक्सट्रैक्ट करें. अगर आपके पास ऐक्सेस नहीं है, तो अपने प्रतिनिधि से संपर्क करें.
Android Studio में, कोई प्रोजेक्ट खोलें. इसके बाद, SDK Manager का इस्तेमाल करके, Google Play services पैकेज जोड़ें.
ज़िप फ़ाइल डायरेक्ट्री से,
libs/google_navigation_navmap.aar
को अपने प्रोजेक्ट कीapp/libs
डायरेक्ट्री में कॉपी करें.अपने मॉड्यूल-लेवल
build.gradle
में यह जोड़ें:implementation(name: 'google_navigation_navmap', ext: 'aar')
इसके बाद, टॉप-लेवल
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' } } }
बिल्ड कॉन्फ़िगर करना
प्रोजेक्ट बनाने के बाद, Navigation SDK का इस्तेमाल करने और उसे सही तरीके से बनाने के लिए, सेटिंग कॉन्फ़िगर की जा सकती हैं.
स्थानीय प्रॉपर्टी अपडेट करना
- Gradle Scripts फ़ोल्डर में,
local.properties
फ़ाइल खोलें औरandroid.useDeprecatedNdk=true
जोड़ें.
Gradle बिल्ड स्क्रिप्ट को अपडेट करना
build.gradle (Module:app)
फ़ाइल खोलें और इन दिशा-निर्देशों का इस्तेमाल करके, सेटिंग अपडेट करें. इससे Navigation SDK की ज़रूरी शर्तें पूरी की जा सकेंगी. साथ ही, ऑप्टिमाइज़ेशन के विकल्प भी सेट किए जा सकेंगे.Navigation SDK के लिए ज़रूरी सेटिंग
minSdkVersion
को 23 या इससे ज़्यादा पर सेट करें.targetSdkVersion
को 30 या इससे ज़्यादा पर सेट करें.dexOptions
सेटिंग जोड़ें, जिससेjavaMaxHeapSize
बढ़ जाए.- अतिरिक्त लाइब्रेरी के लिए जगह सेट करें.
- Navigation SDK के लिए,
repositories
औरdependencies
जोड़ें. - डिपेंडेंसी में मौजूद वर्शन नंबर को, उपलब्ध नए वर्शन से बदलें.
बिल्ड टाइम को कम करने के लिए वैकल्पिक सेटिंग
- डिपेंडेंसी से इस्तेमाल न होने वाले कोड और संसाधनों को हटाने के लिए, R8/ProGuard का इस्तेमाल करके कोड और संसाधन छोटा करने की सुविधा चालू करें. अगर R8/ProGuard को चलने में बहुत ज़्यादा समय लगता है, तो डेवलपमेंट के काम के लिए multidex को चालू करें.
- बिल्ड में शामिल किए गए भाषा अनुवादों की संख्या कम करें: डेवलपमेंट के दौरान, एक भाषा के लिए
resConfigs
सेट करें. फ़ाइनल बिल्ड के लिए, उन भाषाओं के लिएresConfigs
सेट करें जिनका इस्तेमाल किया जाता है. डिफ़ॉल्ट रूप से, Gradle में Navigation SDK के साथ काम करने वाली सभी भाषाओं के लिए संसाधन स्ट्रिंग शामिल होती हैं.
यहां ऐप्लिकेशन के लिए Gradle बिल्ड स्क्रिप्ट का एक उदाहरण दिया गया है. डिपेंडेंसी के अपडेट किए गए सेट के लिए, सैंपल ऐप्लिकेशन देखें. ऐसा इसलिए, क्योंकि हो सकता है कि आपके इस्तेमाल किए जा रहे Navigation SDK का वर्शन, इस दस्तावेज़ में दिए गए वर्शन से थोड़ा आगे या पीछे हो.
apply plugin: 'com.android.application'
apply plugin: 'com.google.cloud.artifactregistry.gradle-plugin'
ext {
androidxVersion = "1.0.0"
lifecycle_version = "1.1.1"
}
android {
compileSdkVersion 30
buildToolsVersion '28.0.3'
defaultConfig {
applicationId "<your id>"
// Navigation SDK supports SDK 23 and later.
minSdkVersion 23
targetSdkVersion 30
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 {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
// This tells Gradle where to look to find additional libraries - in this case, the
// google_navigation_navmap.aar file.
repositories {
flatDir {
dirs 'libs'
}
google()
// Required for accessing the Navigation SDK on Google's Maven repository.
maven {
url "artifactregistry://us-west2-maven.pkg.dev/gmp-artifacts/transportation"
}
}
dependencies {
// Include the Google Navigation SDK
implementation 'com.google.android.maps:navsdk:4.4.0'
// The included AAR file under libs can be used instead of the Maven repository.
// Uncomment the line below and comment out the previous dependency to use
// the AAR file instead. Make sure that you add the AAR file to the libs directory.
// implementation(name: 'google_navigation_navmap', ext: 'aar')
// These dependencies are required for the Navigation SDK to function
// properly at runtime.
implementation 'org.chromium.net:cronet-fallback:69.3497.100'
// Optional for Cronet users:
// implementation 'org.chromium.net:cronet-api:69.3497.100'
implementation 'androidx.appcompat:appcompat:${androidxVersion}'
implementation 'androidx.cardview:cardview:${androidxVersion}'
implementation 'com.google.android.material:material:${androidxVersion}'
implementation 'androidx.mediarouter:mediarouter:${androidxVersion}'
implementation 'androidx.preference:preference:${androidxVersion}'
implementation 'androidx.recyclerview:recyclerview:${androidxVersion}'
implementation 'androidx.legacy:legacy-support-v4:${androidxVersion}'
implementation 'com.github.bumptech.glide:glide:4.9.0'
implementation 'com.github.bumptech.glide:okhttp-integration:4.9.0'
implementation 'android.arch.lifecycle:common-java8:$lifecycle_version'
implementation 'com.android.support:multidex:1.0.3'
implementation 'com.google.android.datatransport:transport-api:2.2.0'
implementation 'com.google.android.datatransport:transport-backend-cct:2.2.0'
implementation 'com.google.android.datatransport:transport-runtime:2.2.0'
implementation 'joda-time:joda-time:2.9.9'
annotationProcessor 'androidx.annotation:annotation:1.1.0'
annotationProcessor 'com.github.bumptech.glide:compiler:4.9.0'
}
अपने ऐप्लिकेशन में एपीआई पासकोड जोड़ना
इस सेक्शन में बताया गया है कि अपने एपीआई पासकोड को कैसे सेव करें, ताकि आपका ऐप्लिकेशन इसे सुरक्षित तरीके से रेफ़र कर सके. आपको अपने एपीआई पासकोड को वर्शन कंट्रोल सिस्टम में सेव नहीं करना चाहिए. इसलिए, हम इसे secrets.properties
फ़ाइल में सेव करने का सुझाव देते हैं. यह फ़ाइल, आपके प्रोजेक्ट की रूट डायरेक्ट्री में मौजूद होती है. secrets.properties
फ़ाइल के बारे में ज़्यादा जानकारी के लिए, Gradle प्रॉपर्टी फ़ाइलें देखें.
हमारा सुझाव है कि इस काम को आसान बनाने के लिए, Android के लिए सीक्रेट ग्रेडल प्लग इन का इस्तेमाल करें.
अपने Google Maps प्रोजेक्ट में, Android के लिए सीक्रेट ग्रेडल प्लग इन इंस्टॉल करने के लिए:
-
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" } }
-
अपने मॉड्यूल-लेवल की
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' }
- अपने मॉड्यूल-लेवल की
build.gradle.kts
याbuild.gradle
फ़ाइल में, पक्का करें किtargetSdk
औरcompileSdk
को 34 पर सेट किया गया हो. - अपने प्रोजेक्ट को Gradle के साथ सिंक करें.
-
अपनी टॉप-लेवल डायरेक्ट्री में मौजूद
secrets.properties
फ़ाइल खोलें. इसके बाद, यह कोड जोड़ें.YOUR_API_KEY
को अपने एपीआई पासकोड से बदलें. अपनी कुंजी को इस फ़ाइल में सेव करें, क्योंकिsecrets.properties
को वर्शन कंट्रोल सिस्टम में शामिल नहीं किया जाता.MAPS_API_KEY=YOUR_API_KEY
-
अपनी टॉप-लेवल डायरेक्ट्री में
local.defaults.properties
फ़ाइल बनाएं. यह फ़ाइल,secrets.properties
फ़ाइल वाले फ़ोल्डर में ही होनी चाहिए. इसके बाद, यह कोड जोड़ें.MAPS_API_KEY=DEFAULT_API_KEY
इस फ़ाइल का मकसद, एपीआई पासकोड के लिए बैकअप की जगह उपलब्ध कराना है. ऐसा तब किया जाता है, जब
secrets.properties
फ़ाइल नहीं मिलती है, ताकि बिल्ड फ़ेल न हों. ऐसा तब हो सकता है, जब आपने वर्शन कंट्रोल सिस्टम से ऐप्लिकेशन को क्लोन किया हो, जिसमेंsecrets.properties
शामिल न हो और आपने एपीआई पासकोड देने के लिए, अब तक स्थानीय तौर परsecrets.properties
फ़ाइल न बनाई हो. -
अपनी
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 के लिए नेविगेशन एसडीके भी शामिल है. पुराने सिस्टम के साथ काम करने की सुविधा के लिए, एपीआईcom.google.android.maps.v2.API_KEY
नाम का इस्तेमाल भी किया जा सकता है. इस लेगसी नाम से, सिर्फ़ Android Maps API v2 के लिए पुष्टि की जा सकती है. कोई ऐप्लिकेशन, एपीआई कुंजी के मेटाडेटा के सिर्फ़ एक नाम के बारे में बता सकता है. अगर दोनों को तय किया जाता है, तो एपीआई एक अपवाद दिखाता है. -
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" }
अपने ऐप्लिकेशन में ज़रूरी एट्रिब्यूशन शामिल करना
अगर आपने अपने ऐप्लिकेशन में Navigation SDK for Android का इस्तेमाल किया है, तो आपको अपने ऐप्लिकेशन के कानूनी सूचनाओं वाले सेक्शन में एट्रिब्यूशन टेक्स्ट और ओपन सोर्स लाइसेंस शामिल करने होंगे.
आपको ज़रूरी एट्रिब्यूशन टेक्स्ट और ओपन सोर्स लाइसेंस, Android के लिए Navigation SDK टूल की ज़िप फ़ाइल में मिल सकते हैं:
NOTICE.txt
LICENSES.txt