अपना प्रोजेक्ट सेट करें -- 4.99 और इससे पहले के वर्शन

इस गाइड में, Android के लिए Navigation SDK का इस्तेमाल करने के लिए, बिल्ड कॉन्फ़िगरेशन से जुड़ी ज़रूरी शर्तें बताई गई हैं. इन निर्देशों के मुताबिक, यह मान लिया जाता है कि आपने Android IDE इंस्टॉल किया है और आपको Android डेवलपमेंट के बारे में जानकारी है.

Navigation SDK का इस्तेमाल करने के लिए ज़रूरी शर्तें

ये ज़रूरी शर्तें, Android के लिए Navigation SDK के 4.99 और इससे पहले के वर्शन पर लागू होती हैं.

  • कोई Google Cloud Console

    जिसमें Navigation SDK की सुविधा चालू हो. प्रोविज़निंग के लिए, Google Maps Platform के अपने प्रतिनिधि से संपर्क करें.

  • आपके ऐप्लिकेशन को एपीआई लेवल 30 या इसके बाद के लेवल को टारगेट करना होगा.

  • Navigation SDK की मदद से बनाए गए किसी ऐप्लिकेशन को चलाने के लिए, Android डिवाइस में Google Play services इंस्टॉल और चालू होनी चाहिए.

  • एट्रिब्यूशन और लाइसेंसिंग टेक्स्ट ऐप्लिकेशन में जोड़ा जाना चाहिए.

अपने प्रोजेक्ट सेट अप करना: Cloud Console प्रोजेक्ट और Android प्रोजेक्ट

किसी ऐप्लिकेशन को बनाने या टेस्ट करने से पहले, आपको Cloud Console प्रोजेक्ट बनाना होगा. साथ ही, एपीआई पासकोड के क्रेडेंशियल जोड़ने होंगे. प्रोजेक्ट में, Navigation SDK को ऐक्सेस करने के लिए प्रोविज़निंग की सुविधा होनी चाहिए. Cloud Console प्रोजेक्ट में मौजूद सभी पासकोड को, Navigation SDK का एक जैसा ऐक्सेस मिलता है. किसी पासकोड से एक से ज़्यादा डेवलपमेंट प्रोजेक्ट जुड़े हो सकते हैं. अगर आपके पास पहले से कोई कंसोल प्रोजेक्ट है, तो अपने मौजूदा प्रोजेक्ट में कोई पासकोड जोड़ा जा सकता है.

सेट अप करने के लिए

  1. अपने पसंदीदा वेब ब्राउज़र में, Cloud Console में साइन इन करें और अपना Cloud Console प्रोजेक्ट बनाएं.
  2. अपने आईडीई में, जैसे कि Android Studio में, Android ऐप्लिकेशन डेवलपमेंट प्रोजेक्ट बनाएं और पैकेज का नाम नोट करें.
  3. अपने Cloud Console प्रोजेक्ट के लिए, Navigation SDK का ऐक्सेस पाने के लिए, Google Maps Platform के अपने प्रतिनिधि से संपर्क करें.
  4. अपने वेब ब्राउज़र में Cloud Console डैशबोर्ड पर, पाबंदियों के साथ एपीआई पासकोड जनरेट करने के लिए क्रेडेंशियल बनाएं.
  5. एपीआई पासकोड पेज पर, ऐप्लिकेशन की पाबंदियां वाले सेक्शन में, Android ऐप्लिकेशन पर क्लिक करें.
  6. पैकेज का नाम और फ़िंगरप्रिंट जोड़ें पर क्लिक करें. इसके बाद, अपने डेवलपमेंट प्रोजेक्ट का पैकेज नाम और उस पासकोड के लिए SHA-1 फ़िंगरप्रिंट डालें.
  7. सेव करें पर क्लिक करें.

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

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

Navigation SDK के 4.5 और इसके बाद के वर्शन के लिए Maven का इस्तेमाल करना (सुझाया गया)

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

  1. अपने Gradle या Maven कॉन्फ़िगरेशन में यह डिपेंडेंसी जोड़ें. साथ ही, VERSION_NUMBER प्लेसहोल्डर को Android के लिए Navigation SDK के वर्शन से बदलें.

    Gradle

    अपने मॉड्यूल-लेवल 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, वर्शन 4 के बाकी वर्शन के लिए, ओरिजनल Maven डेटा स्टोर करने की जगह का इस्तेमाल करके उपलब्ध रहेगा. यह वही लाइब्रेरी है जिसमें ऊपर बताए गए वर्शन के सभी अपडेट शामिल हैं. साथ ही, यह ट्रांज़िशन के दौरान Driver SDK और अन्य लाइब्रेरी के साथ काम करती है. इस डिपेंडेंसी का इस्तेमाल करने के लिए, कंपाइल करते समय gcloud का इस्तेमाल करके, अपने क्लाउड प्रोजेक्ट में लॉग इन करना ज़रूरी है.

  1. Google के Maven रिपॉज़िटरी को ऐक्सेस करने के लिए, अपना एनवायरमेंट सेट अप करें. इसके लिए, Consumer SDK के दस्तावेज़ के the ज़रूरी शर्तें सेक्शन में बताया गया तरीका अपनाएं. Navigation SDK का ऐक्सेस, Workspace ग्रुप के ज़रिए कंट्रोल किया जाता है.

  2. अपने Gradle या Maven कॉन्फ़िगरेशन में यह डिपेंडेंसी जोड़ें. साथ ही, VERSION_NUMBER प्लेसहोल्डर को Navigation SDK के वर्शन से बदलें.

    Gradle

    अपने मॉड्यूल-लेवल 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 बंडल के तौर पर भी उपलब्ध है. डेवलपमेंट प्रोजेक्ट बनाने के बाद, एसडीके को इंटिग्रेट किया जा सकता है. इन निर्देशों के मुताबिक, यह मान लिया जाता है कि आपके आईडीई के लिए Android Studio का इस्तेमाल किया जा रहा है.

  1. शेयर किए गए Google Drive से, Navigation SDK का नया वर्शन डाउनलोड करें और उसे एक्सट्रैक्ट करें. अगर आपके पास ऐक्सेस नहीं है, तो अपने प्रतिनिधि से संपर्क करें.

  2. Android Studio में, कोई प्रोजेक्ट खोलें और एसडीके मैनेजर का इस्तेमाल करके, Google Play services पैकेज जोड़ें.

  3. ज़िप फ़ाइल डायरेक्ट्री से, libs/google_navigation_navmap.aar को अपने प्रोजेक्ट की app/libs डायरेक्ट्री में कॉपी करें.

  4. अपने मॉड्यूल-लेवल 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 के लिए ज़रूरी सेटिंग

    1. minSdkVersion को 23 या इससे ज़्यादा पर सेट करें.
    2. targetSdkVersion को 30 या इससे ज़्यादा पर सेट करें.
    3. dexOptions सेटिंग जोड़ें, जिससे javaMaxHeapSize बढ़ जाता है.
    4. अतिरिक्त लाइब्रेरी के लिए जगह सेट करें.
    5. Navigation SDK के लिए repositories और dependencies जोड़ें.
    6. डिपेंडेंसी में मौजूद वर्शन नंबर को, उपलब्ध नए वर्शन से बदलें.

    बिल्ड प्रोसेस में लगने वाला समय कम करने के लिए वैकल्पिक सेटिंग

    • डिपेंडेंसी से, इस्तेमाल न होने वाले कोड और संसाधनों को हटाने के लिए, 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 के लिए Secrets Gradle Plugin का इस्तेमाल करें.

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

  1. Android Studio में, रूट-लेवल build.gradle फ़ाइल खोलें और dependencies एलिमेंट में यह कोड जोड़ें जो buildscript में मौजूद है.

    Groovy

    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 एलिमेंट में यह कोड जोड़ें.

    Groovy

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

    • प्रोग्राम के ज़रिए एपीआई पासकोड देना:

      Secrets Gradle Plugin, 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 दिखाता है.
      • Navigator जैसे Navigation SDK के किसी भी कॉम्पोनेंट को शुरू करने से पहले, setApiKey() को कॉल करें.
      • इस तरीके से दिया गया पासकोड, आपके AndroidManifest.xml में मौजूद किसी भी एपीआई पासकोड को बदल देता है.
      • Navigation SDK के 7.6 या इसके बाद के वर्शन का इस्तेमाल करें.

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

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

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

  • NOTICE.txt
  • LICENSES.txt