Menyiapkan project -- Versi 4.99 dan versi sebelumnya

Penting: Panduan ini HANYA berlaku untuk project yang menggunakan Navigation SDK for Android versi 4.99 dan yang lebih lama. Jika Anda telah mengupdate project ke versi 5.0 atau yang lebih baru, ikuti petunjuk penyiapan untuk penginstalan paket, versi, dan detail dependensi terbaru.

Panduan ini mencantumkan persyaratan konfigurasi build untuk menggunakan Navigation SDK for Android. Petunjuk ini mengasumsikan Anda telah menginstal IDE Android dan memahami pengembangan Android.

Peringatan: Mulai Navigation SDK (Versi 4.0), API tidak lagi mendukung Android KitKat atau Lollipop (4.4-5.1).

Persyaratan minimum untuk menggunakan Navigation SDK

Persyaratan ini berlaku untuk Navigation SDK for Android versi 4.99 dan yang lebih lama.

• Konsol Google Cloud

  project dengan Navigation SDK yang diaktifkan. Untuk penyediaan, hubungi perwakilan Google Maps Platform Anda.

• Aplikasi Anda harus menargetkan API level 30 atau yang lebih tinggi.

• Untuk menjalankan aplikasi yang dibuat dengan Navigation SDK, perangkat Android harus menginstal dan mengaktifkan layanan Google Play.

• Teks atribusi dan pemberian lisensi harus ditambahkan ke aplikasi.

Siapkan project Anda: Project konsol Cloud dan project Android

Sebelum dapat membuat atau menguji aplikasi, Anda perlu membuat project konsol Cloud dan menambahkan kredensial kunci API. Project harus memiliki penyediaan untuk mengakses Navigation SDK. Semua kunci dalam project Cloud Console diberi akses yang sama ke Navigation SDK. Kunci dapat memiliki lebih dari satu project pengembangan yang terkait dengannya. Jika sudah memiliki project konsol, Anda dapat menambahkan kunci ke project saat ini.

Informasi yang Anda perlukan untuk menyiapkan project:

• Nama perwakilan Google Maps Platform Anda.
• Nama untuk project konsol Cloud Anda.
• Nama untuk project pengembangan aplikasi Android Anda yang memiliki nama paket yang Anda perlukan nanti.
• Sidik jari sertifikat SHA-1 untuk mesin pengembangan Anda.

Untuk menyiapkan

1. Di browser web favorit Anda, login ke Konsol Cloud dan buat project Konsol Cloud Anda.
2. Di IDE Anda, seperti Android Studio, buat project pengembangan aplikasi Android dan catat nama paketnya.
3. Hubungi perwakilan Google Maps Platform Anda untuk memberikan akses ke Navigation SDK untuk project konsol Cloud Anda.
4. Saat berada di dasbor konsol Cloud di browser web Anda, buat kredensial untuk membuat kunci API dengan batasan.
5. Di halaman kunci API, klik Aplikasi Android di area Pembatasan aplikasi.
6. Klik Tambahkan nama paket dan sidik jari, lalu masukkan nama paket project pengembangan Anda dan sidik jari SHA-1 untuk kunci tersebut.
7. Klik Simpan.

Menambahkan Navigation SDK ke project Anda

Navigation SDK tersedia menggunakan Maven, atau sebagai paket AAR. Setelah membuat project pengembangan, Anda dapat mengintegrasikan SDK ke dalamnya dengan menggunakan salah satu pendekatan berikut.

Penting: Anda harus menggunakan dependensi Maven di project untuk menautkan Navigation SDK for Android. Download paket AAR tidak akan tersedia di masa mendatang.

Menggunakan Maven untuk Navigation SDK v4.5 dan yang lebih baru (direkomendasikan)

Berikut menggunakan repositori Maven google(), yang merupakan cara termudah dan direkomendasikan untuk menambahkan Navigation SDK ke project Anda

Catatan: Pendekatan ini tidak kompatibel dengan beberapa library yang bergantung pada Navigation SDK menggunakan ID artefak sebelumnya. Hal ini mencakup rilis Driver SDK v4.4 atau yang lebih lama.

1. Tambahkan dependensi berikut ke konfigurasi Gradle atau Maven Anda, dengan mengganti placeholder VERSION_NUMBER dengan versi Navigation SDK for Android.

   Gradle

   Tambahkan kode berikut ke build.gradle tingkat modul Anda:

   dependencies {
   ...
   implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER'
   }
   

   Jika mengupgrade dari repositori Maven asli, perhatikan bahwa nama grup dan artefak telah berubah, dan plugin com.google.cloud.artifactregistry.gradle-plugin tidak lagi diperlukan.

   Lalu, tambahkan kode berikut ke build.gradle tingkat teratas Anda:

   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

   Tambahkan kode berikut ke pom.xml Anda:

   <dependencies>
   ...
   <dependency>
        <groupId>com.google.android.libraries.navigation</groupId>
        <artifactId>navigation</artifactId>
        <version>VERSION_NUMBER</version>
   </dependency>
   </dependencies>
   

   Jika Anda memiliki dependensi yang menggunakan Maps SDK, Anda harus mengecualikan dependensi di setiap dependensi yang dideklarasikan yang mengandalkan 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>
   

Menggunakan Maven untuk Navigation SDK sebelum v4.5, atau dengan Driver SDK

Navigation SDK terus tersedia menggunakan repositori Maven asli melalui versi v4 lainnya. Library ini sama dengan semua update yang sama seperti versi di atas, dan memberikan kompatibilitas dengan Driver SDK dan library lainnya selama transisi. Penggunaan dependensi ini memerlukan login ke project cloud Anda menggunakan gcloud saat mengompilasi.

1. Siapkan lingkungan Anda untuk mengakses repositori Maven Google seperti yang dijelaskan di bagian Prasyarat dalam dokumentasi Consumer SDK. Akses ke Navigation SDK dikontrol melalui grup ruang kerja.

2. Tambahkan dependensi berikut ke konfigurasi Gradle atau Maven Anda, dengan mengganti placeholder VERSION_NUMBER untuk versi Navigation SDK.

   Gradle

   Tambahkan kode berikut ke build.gradle tingkat modul Anda:

   dependencies {
   ...
   implementation 'com.google.android.maps:navsdk:VERSION_NUMBER'
   }
   

   Lalu, tambahkan kode berikut ke build.gradle tingkat teratas Anda:

   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

   Tambahkan kode berikut ke pom.xml Anda:

   <dependencies>
   ...
   <dependency>
        <groupId>com.google.android.maps</groupId>
        <artifactId>navsdk</artifactId>
        <version>VERSION_NUMBER</version>
   </dependency>
   </dependencies>
   

   Jika Anda memiliki dependensi yang menggunakan Maps SDK, Anda harus mengecualikan dependensi di setiap dependensi yang dideklarasikan yang mengandalkan 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>
   

Menggunakan paket AAR yang didownload (tidak direkomendasikan)

Navigation SDK juga tersedia sebagai paket AAR. Setelah membuat project pengembangan, Anda dapat mengintegrasikan SDK. Petunjuk ini mengasumsikan penggunaan Android Studio untuk IDE Anda.

1. Download Navigation SDK versi terbaru dari Google Drive bersama dan ekstrak. Jika Anda tidak memiliki akses, hubungi perwakilan Anda.

2. Di Android Studio, buka project dan tambahkan paket layanan Google Play menggunakan SDK Manager.

3. Dari direktori file ZIP, salin libs/google_navigation_navmap.aar ke direktori app/libs project Anda.

4. Tambahkan kode berikut ke build.gradle tingkat modul Anda:

   implementation(name: 'google_navigation_navmap', ext: 'aar')
   

   Lalu, tambahkan kode berikut ke build.gradle tingkat teratas Anda:

   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'
          }
      }
   }
   

Mengonfigurasi build

Setelah membuat project, Anda dapat mengonfigurasi setelan untuk build dan penggunaan Navigation SDK yang berhasil.

Memperbarui properti lokal

• Di folder Gradle Scripts, buka file local.properties dan tambahkan android.useDeprecatedNdk=true.

Memperbarui skrip build Gradle

• Buka file build.gradle (Module:app) dan gunakan panduan berikut untuk memperbarui setelan agar memenuhi persyaratan Navigation SDK dan pertimbangkan untuk menyetel opsi pengoptimalan juga.

  Setelan yang diperlukan untuk Navigation SDK

  1. Tetapkan minSdkVersion ke 23 atau yang lebih tinggi.
  2. Tetapkan targetSdkVersion ke 30 atau lebih tinggi.
  3. Tambahkan setelan dexOptions yang meningkatkan javaMaxHeapSize.
  4. Tetapkan lokasi untuk library tambahan.
  5. Tambahkan repositories dan dependencies untuk Navigation SDK.
  6. Ganti nomor versi dalam dependensi dengan versi terbaru yang tersedia.

  Setelan opsional untuk mengurangi waktu build

  • Aktifkan penyingkatan kode dan penyingkatan resource menggunakan R8/ProGuard untuk menghapus kode dan resource yang tidak digunakan dari dependensi. Jika langkah R8/ProGuard memerlukan waktu terlalu lama untuk dijalankan, pertimbangkan untuk mengaktifkan multidex untuk tugas pengembangan.
  • Kurangi jumlah terjemahan bahasa yang disertakan dalam build: Tetapkan resConfigs untuk satu bahasa selama pengembangan. Untuk build akhir, tetapkan resConfigs untuk bahasa yang benar-benar Anda gunakan. Secara default, Gradle menyertakan string resource untuk semua bahasa yang didukung oleh Navigation SDK.

Berikut adalah contoh skrip build Gradle untuk aplikasi. Periksa aplikasi contoh untuk mengetahui kumpulan dependensi yang telah diupdate, karena versi Navigation SDK yang Anda gunakan mungkin sedikit lebih baru atau lebih lama dari dokumentasi ini.

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'
}

Menambahkan kunci API ke aplikasi

Bagian ini menjelaskan cara menyimpan kunci API sehingga dapat dirujuk dengan aman oleh aplikasi Anda. Anda tidak boleh memasukkan kunci API ke dalam sistem kontrol versi Anda, jadi sebaiknya simpan kunci tersebut dalam file secrets.properties, yang terletak di direktori root project Anda. Untuk informasi selengkapnya tentang file secrets.properties, lihat file properti Gradle.

Untuk menyederhanakan tugas ini, sebaiknya Anda menggunakan Plugin Secrets Gradle untuk Android.

Untuk menginstal Plugin Secrets Gradle untuk Android dan menyimpan kunci API Anda:

1. Di Android Studio, buka file build.gradle tingkat root dan tambahkan kode berikut ke elemen dependencies di bagian 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. Buka file build.gradle tingkat aplikasi dan tambahkan kode berikut ke elemen 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. Jika Anda menggunakan Android Studio, sinkronkan project Anda dengan Gradle.
4. Buka local.properties di direktori tingkat project, lalu tambahkan kode berikut. Ganti YOUR_API_KEY dengan kunci API Anda.

   MAPS_API_KEY=YOUR_API_KEY

5. Dalam file AndroidManifest.xml Anda, buka com.google.android.geo.API_KEY dan perbarui atribut android:value sebagai berikut:

   <meta-data
       android:name="com.google.android.geo.API_KEY"
       android:value="${MAPS_API_KEY}" />
       

   Catatan: com.google.android.geo.API_KEY adalah nama metadata yang disarankan untuk kunci API. Kunci dengan nama ini dapat digunakan untuk mengautentikasi beberapa API berbasis Google Maps sekaligus di platform Android, termasuk Navigation SDK for Android. Untuk kompatibilitas mundur, API tersebut juga mendukung nama com.google.android.maps.v2.API_KEY. Nama lama ini hanya memungkinkan autentikasi untuk Android Maps API v2. Aplikasi hanya dapat menentukan salah satu nama metadata kunci API. Jika keduanya ditentukan, API akan menampilkan pengecualian.

Sertakan atribusi yang diperlukan di aplikasi Anda

Jika Anda menggunakan Navigation SDK for Android di aplikasi, Anda harus menyertakan teks atribusi dan lisensi open source sebagai bagian dari bagian pemberitahuan hukum aplikasi Anda.

Poin penting: Untuk menyertakan atribusi, tambahkan atribusi sebagai item menu terpisah atau item di menu Tentang.

Anda dapat menemukan teks atribusi dan lisensi open source yang diperlukan dalam file zip Navigation SDK for Android:

• NOTICE.txt
• LICENSES.txt