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

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

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

  1. अपने Gradle या Maven कॉन्फ़िगरेशन में ये डिपेंडेंसी जोड़ें, VERSION_NUMBER प्लेसहोल्डर को Android के लिए नेविगेशन 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. 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>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. इसके लिए repositories और dependencies जोड़ें नेविगेशन SDK टूल.
    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 प्रॉपर्टी फ़ाइलें.

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

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

  1. Android Studio में, अपना टॉप-लेवल build.gradle या build.gradle.kts खोलें फ़ाइल और निम्न कोड को dependencies तत्व में जोड़ें buildscript.

    ग्रूवी

    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. फ़ाइल सेव करें और Gredle के साथ प्रोजेक्ट सिंक करते हैं.
  5. अपनी शीर्ष-स्तरीय डायरेक्ट्री में secrets.properties फ़ाइल खोलें, और फिर जोड़ें . YOUR_API_KEY को अपनी एपीआई पासकोड से बदलें. अपनी कुंजी इस फ़ाइल में सेव करें ऐसा इसलिए हुआ, क्योंकि वर्शन कंट्रोल में secrets.properties की जांच नहीं की जा सकी सिस्टम.
    NAV_API_KEY=YOUR_API_KEY
  6. फ़ाइल सेव करें.
  7. अपनी टॉप-लेवल डायरेक्ट्री में local.defaults.properties फ़ाइल बनाएं. फ़ोल्डर को secrets.properties फ़ाइल के रूप में चुनकर यह कोड जोड़ें.

    NAV_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).