Navigation SDK זמין כרגע רק ללקוחות נבחרים. למידע נוסף, אפשר לפנות למחלקת המכירות.

עיצוב חדש של מפות יהיה זמין בקרוב בפלטפורמה של מפות Google. העדכון הזה בסגנון המפה כולל לוח צבעים חדש שמוגדר כברירת מחדל ושיפורים בחוויית השימוש במפות ובנוחות השימוש. כל סגנונות המפה יעודכנו באופן אוטומטי במרץ 2025. אפשר לקרוא מידע נוסף על זמינות ועל האפשרות להצטרף בשלב מוקדם יותר במאמר בנושא סגנון מפה חדש לפלטפורמה של מפות Google.

דף זה תורגם על ידי Cloud Translation API.

הגדרת הפרויקט – גרסה 4.99 וגרסאות קודמות

במדריך הזה מפורטות הדרישות לגבי תצורת build לשימוש SDK ניווט ל-Android. ההנחיות מבוססות על ההנחה שיש לך Android IDE מותקנים ומכירים את פיתוח Android.

דרישות מינימליות לשימוש ב-Navigation SDK

הדרישות האלה חלות על Navigation SDK ל-Android בגרסה 4.99 ובגרסאות קודמות.

פרויקט במסוף Google Cloud ש-Navigation SDK מופעל בו. להקצאת הרשאות ידנית, צריך לפנות לנציג שלכם בפלטפורמה של מפות Google.
האפליקציה חייבת לטרגט לרמת API 30 ומעלה.
כדי להריץ אפליקציה שנבנתה באמצעות ה-SDK לניווט, ה-Android אפליקציית Google Play Services צריכה להיות מותקנת במכשיר מותקנת ומופעלת.
טקסט של שיוך ורישוי להוספה לאפליקציה.

הגדרת הפרויקטים: פרויקט במסוף Cloud ופרויקט Android

לפני שיוצרים או בודקים אפליקציה, צריך ליצור פרויקט במסוף Cloud ולהוסיף פרטי כניסה של מפתח API. לפרויקט צריכה להיות הקצאה כדי לגשת אל SDK ניווט. כל המפתחות בפרויקט במסוף Cloud מקבלים את אותה גישה ל-Navigation SDK. מפתח יכול להיות משויך אליו יותר מפרויקט פיתוח אחד. אם כבר יש לכם פרויקט במסוף, אתם יכולים להוסיף מפתח לפרויקט הנוכחי.

כדי להגדיר

בדפדפן האינטרנט המועדף עליכם, נכנסים אל Cloud Console ויוצרים מסוף Cloud פרויקט.
בסביבת IDE, למשל Android Studio, צריך ליצור פיתוח של אפליקציה ל-Android פרויקט ומציינים את שם החבילה.
יש לפנות לנציג שלך בפלטפורמה של מפות Google כדי לספק גישה SDK ניווט למסוף Cloud פרויקט.
בזמן שנמצאים במרכז השליטה של מסוף Cloud בדפדפן האינטרנט, ליצור פרטי כניסה כדי ליצור מפתח API עם הגבלות.
בדף API key, לוחצים על apps ל-Android בקטע Application restrictions. אזור.
לוחצים על הוספת שם החבילה וטביעת האצבע ולאחר מכן מזינים את החבילה. השם של פרויקט הפיתוח וטביעת האצבע SHA-1 של המפתח הזה.
לוחצים על שמירה.

הוספת SDK לניווט לפרויקט

ה-Navigation SDK זמין דרך Maven, או חבילת AAR. אחרי שיוצרים פרויקט פיתוח, אפשר לשלב את ה-SDK בו על ידי באחת מהשיטות הבאות.

שימוש ב-Maven for Navigation SDK בגרסה 4.5 ואילך (מומלץ)

בדוגמה הבאה נעשה שימוש במאגר Maven, שהוא google() והדרך המומלצת להוסיף את ה-SDK לניווט פרויקט

מוסיפים את התלות הבאה להגדרות של Gradle או Maven, מחליפים את ה-placeholder VERSION_NUMBER ב- הגרסה הרצויה של SDK ניווט ל-Android.

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. 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>com.google.android.libraries.navigation</groupId>
    <artifactId>navigation</artifactId>
    <version>VERSION_NUMBER</version>
  </dependency>
</dependencies>

אם יש לך יחסי תלות שמשתמשים ב-SDK של מפות Google, עליך להחריג את תלות בכל תלות מוצהרת שמסתמכת על ה-SDK של מפות Google.

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

שימוש ב-Maven for Navigation SDK לפני גרסה 4.5, או עם Driver SDK

ערכת ה-SDK לניווט תמשיך להיות זמינה דרך ממאגר Maven המקורי עד סוף הגרסאות של גרסה 4. כאן את אותה ספרייה, עם כל אותם עדכונים כמו הגרסה שלמעלה, תאימות ל-Driver SDK ולספריות אחרות במהלך המעבר. באמצעות התלות הזאת דורשת כניסה לפרויקט בענן דרך gcloud, היא הידור.

מגדירים את הסביבה כדי לגשת למאגר Maven של Google, כפי שמתואר ב דרישות מוקדמות בקטע הרלוונטי במסמכי התיעוד לצרכנים בנושא SDK. גישה אל ה-SDK לניווט נשלט באמצעות קבוצה של סביבת עבודה.

מוסיפים את התלות הבאה להגדרות של Gradle או Maven, ומחליפים את placeholder של VERSION_NUMBER לגרסת הניווט הרצויה של ה-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. 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>com.google.android.maps</groupId>
    <artifactId>navsdk</artifactId>
    <version>VERSION_NUMBER</version>
  </dependency>
</dependencies>

אם יש לך יחסי תלות שמשתמשים ב-SDK של מפות Google, עליך להחריג את תלות בכל תלות מוצהרת שמסתמכת על ה-SDK של מפות Google.

<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 שהורדת (לא מומלץ)

ערכת הניווט SDK זמינה גם כחבילת AAR. אחרי שיוצרים את פרויקט הפיתוח, אפשר לשלב את ה-SDK. ההוראות האלה להניח שהשימוש ב-Android Studio בסביבת הפיתוח המשולבת (IDE) שלך.

הורדת הגרסה האחרונה של ה-SDK לניווט מGoogle Drive המשותף ולחלץ את הקובץ. אם אין להם גישה, יש לפנות לנציג.
ב-Android Studio, פותחים פרויקט ו מוסיפים את חבילת Google Play Services באמצעות מנהל ה-SDK.
מספריית קובצי ה-ZIP, מעתיקים את 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. 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'
        }
    }
}

הגדרת ה-build

לאחר יצירת הפרויקט, ניתן לקבוע את ההגדרות עבור פיתוח מוצלח של SDK ושימוש בו.

עדכון מאפיינים מקומיים

בתיקייה Gradle Scripts, פותחים את הקובץ local.properties ומוסיפים android.useDeprecatedNdk=true

עדכון סקריפט ה-build של Gradle

פותחים את הקובץ build.gradle (Module:app) ופועלים לפי ההנחיות הבאות כדי צריך לעדכן את ההגדרות כדי לעמוד בדרישות של Navigation SDK וכדאי גם להגדיר את אפשרויות האופטימיזציה.

הגדרות נדרשות ל-Navigation SDK
1. מגדירים את הערך של minSdkVersion לערך 23 ומעלה.
2. מגדירים את הערך של targetSdkVersion לערך 30 ומעלה.
3. צריך להוסיף הגדרת dexOptions שמגדילה את הערך של javaMaxHeapSize.
4. הגדרת המיקום לספריות נוספות.
5. מוסיפים את repositories ואת dependencies של ה-SDK לניווט.
6. מחליפים את מספרי הגרסאות של יחסי התלות בגרסאות האחרונות שזמינות.
הגדרות אופציונליות לקיצור זמן ה-build
- אפשר כיווץ הקוד וכיווץ המשאבים באמצעות R8/ProGuard כדי להסיר קוד ומשאבים שלא נמצאים בשימוש מיחסי תלות. אם ההרצה של השלב R8/ProGuard נמשכת יותר מדי זמן, כדאי להפעיל אותו multidex לעבודות פיתוח.
- מצמצמים את מספר התרגומים של השפות הכלולים ב-build: מגדירים resConfigs לשפה אחת במהלך הפיתוח. ל-build הסופי, מגדירים resConfigs לשפות שבהן אתם משתמשים בפועל. כברירת מחדל, Gradle כולל מחרוזות משאבים לכל השפות שנתמכות על ידי Navigation SDK.

בהמשך מוצגת דוגמה לסקריפט ה-build של Gradle לאפליקציה. כדאי לבדוק את אפליקציות לדוגמה לקבוצות מעודכנות של יחסי תלות, כמו הגרסה של ערכת ה-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. Ensure 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'
}

הוספה של מפתח ה-API לאפליקציה

בקטע הזה מוסבר איך לאחסן את מפתח ה-API כדי שתהיה אפשרות להפנות אליו באופן מאובטח באפליקציה שלך. אין לבדוק את מפתח ה-API במערכת ניהול הגרסאות, לכן מומלץ תאחסן אותו בקובץ secrets.properties, שממוקם בתיקיית השורש של פרויקט. מידע נוסף על הקובץ secrets.properties זמין בכתובת קובצי מאפייני Gradle.

כדי לייעל את המשימה הזו, מומלץ פלאגין של Secrets Gradle ל-Android.

כדי להתקין את הפלאגין Secrets Gradle ל-Android בפרויקט במפות Google:

ב-Android Studio, פותחים את build.gradle.kts או build.gradle ברמה העליונה ולהוסיף את הקוד הבא לרכיב dependencies בקטע buildscript

Kotlin

buildscript {
    dependencies {
        classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
    }
}

Groovy

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")
}

Groovy

plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}

בקובץ build.gradle.kts או build.gradle ברמת המודול, מוודאים שtargetSdk ו-compileSdk מוגדרים עד 34.
שומרים את הקובץ ואז לסנכרן את הפרויקט עם Gradle
פותחים את הקובץ secrets.properties בספרייה שברמה העליונה, ואז מוסיפים את באמצעות הקוד הבא. מחליפים את YOUR_API_KEY במפתח ה-API שלכם. אחסון המפתח בקובץ הזה כי secrets.properties לא נכלל בבדיקה לניהול גרסאות המערכת.
הערה: אם הקובץ secrets.properties לא קיים, יוצרים אותו באותה תיקייה שבה נמצא הקובץ local.properties.
```
NAV_API_KEY=YOUR_API_KEY
```
שומרים את הקובץ.
יוצרים את הקובץ local.defaults.properties בספרייה שברמה העליונה, אותה לתיקייה בתור הקובץ secrets.properties, ואז מוסיפים את הקוד הבא.

הערה: צריך להזין את הקוד כמו שמוצג. לא להחליף DEFAULT_API_KEY מחליפים במפתח ה-API.
```
NAV_API_KEY=DEFAULT_API_KEY
```
מטרת הקובץ הזה היא לספק מיקום לגיבוי של מפתח ה-API אם קובץ secrets.properties לא נמצא כדי שגרסאות ה-build לא ייכשלו. הדבר יכול להתרחש אם משכפלים את האפליקציה ממערכת לניהול גרסאות שמושמטת מ-secrets.properties עדיין לא יצרת קובץ secrets.properties באופן מקומי כדי לספק מפתח API.
שומרים את הקובץ.
בקובץ 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.

In Android Studio, open your module-level build.gradle.kts or build.gradle 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.

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"

    // 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.*"
}

Groovy

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"

    // 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.*"
}

לכלול את הייחוסים הנדרשים באפליקציה

אם באפליקציה שלך נעשה שימוש ב-Navigation SDK ל-Android, עליך לכלול טקסט ייחוס ורישיונות קוד פתוח כחלק מההודעות המשפטיות של האפליקציה .

אפשר למצוא את טקסט השיוך הנדרש ואת רישיונות הקוד הפתוח SDK ניווט לקובץ ZIP של Android:

NOTICE.txt
LICENSES.txt