إعداد مشروعك، الإصدار 4.99 والإصدارات الأقدم

يسرد هذا الدليل متطلبات إعدادات الإنشاء لاستخدام Navigation SDK لنظام التشغيل Android. تفترض التعليمات أنّك لديك IDE لنظام Android مثبَّت وأنّك على دراية بتطوير تطبيقات Android.

الحد الأدنى من متطلبات استخدام حزمة SDK للتنقل

تنطبق هذه المتطلبات على حزمة Navigation SDK لنظام التشغيل Android الإصدار 4.99 والإصدارات الأقدم.

• مشروع على Google Cloud Console تم تفعيل حزمة تطوير البرامج (SDK) للتنقّل فيه لتوفير المتطلبات اللازمة، اطلب من ممثّل "منصة خرائط Google" الذي تتعامل معه.

• يجب أن يستهدف تطبيقك المستوى 30 أو أعلى لواجهة برمجة التطبيقات.

• لتشغيل تطبيق تم إنشاؤه باستخدام حزمة تطوير البرامج (SDK) لنظام التنقّل، يجب تثبيت خدمات Google Play على جهاز Android وتفعيلها.

• يجب إضافة نصوص الإسناد والترخيص إلى التطبيق.

إعداد مشاريعك: مشروع على Cloud Console ومشروع Android

قبل أن تتمكن من إنشاء تطبيق أو اختباره، يجب إنشاء مشروع على Cloud Console وإضافة بيانات اعتماد مفتاح واجهة برمجة التطبيقات. يجب أن يكون لدى المشروع إذن بالوصول إلى IDE SDK. يتم منح جميع المفاتيح ضمن مشروع Cloud Console إذن الوصول نفسه إلى حزمة SDK Navigation. يمكن أن يكون للمفتاح أكثر من مشروع تطوير واحد مرتبط به. إذا كان لديك مشروع وحدة تحكّم، يمكنك إضافة مفتاح إلى مشروعك الحالي.

لإعداد الجهاز

1. في متصفّح الويب المفضّل لديك، سجِّل الدخول إلى Cloud Console وأنشئ مشروعك على Cloud Console .
2. في IDE، مثل Android Studio، أنشِئ مشروعًا لتطوير تطبيق Android ودوِّن اسم الحزمة.
3. تواصَل مع ممثل "منصّة خرائط Google" لمنح إذن الوصول إلى حزمة تطوير البرامج (SDK) لميزة التنقّل في مشروعك على "وحدة تحكّم Cloud Console".
4. في لوحة بيانات Cloud Console في متصفّح الويب، أنشئ بيانات اعتماد لإنشاء مفتاح واجهة برمجة تطبيقات مع قيود.
5. في صفحة مفتاح واجهة برمجة التطبيقات، انقر على تطبيقات Android في منطقة قيود التطبيقات .
6. انقر على إضافة اسم الحزمة وبصمة الإصبع، ثم أدخِل اسم حزمة مشروع التطوير وبصمة SHA-1 لهذا المفتاح.
7. انقر على حفظ.

إضافة حزمة تطوير البرامج (SDK) لنظام التنقّل إلى مشروعك

تتوفّر حزمة تطوير البرامج (SDK) لنظام التنقّل من خلال Maven أو كأحد ملفّات AAR. بعد إنشاء مشروع التطوير، يمكنك دمج حزمة تطوير البرامج (SDK) فيه باستخدام أحد النهجَين التاليَين:

استخدام الإصدار 4.5 من حزمة Maven لـ Navigation SDK والإصدارات الأحدث (إجراء يُنصح به)

يتم استخدام مستودع Maven التالي على google()، وهي الطريقة الأبسط والمقترَحة لإضافة حزمة تطوير البرامج (SDK) الخاصة بالتنقل إلى مشروعك.

1. أضِف الاعتمادية التالية إلى إعدادات Gradle أو Maven، مع استبدال العنصر النائب 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 للخرائط، يجب استبعاد التبعية في كل اعتمادية تم الإعلان عنها تعتمد على حزمة 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>
   

استخدام Maven للحزمة SDK قبل الإصدار 4.5 أو مع Driver SDK

ستظل حزمة Navigation SDK متاحة من خلال مستودع Maven الأصلي خلال الفترة المتبقية من إصدار 4. وهذه هي المكتبة نفسها التي تتضمّن جميع التحديثات نفسها المتوفّرة في الإصدار أعلاه، وتتوافق مع حزمة تطوير البرامج (SDK) لبرنامج التشغيل والمكتبات الأخرى أثناء عملية النقل. يتطلّب استخدام هذا العنصر التابع تسجيل الدخول إلى مشروعك على السحابة الإلكترونية من خلال gcloud عند الترجمة.

1. يمكنك إعداد بيئتك للوصول إلى مستودع Maven من Google كما هو موضّح في قسم المتطلبات الأساسية من مستندات حزمة تطوير البرامج (SDK) للمستهلكين. يتم التحكّم في الوصول إلى Navigation SDK من خلال مجموعة مساحات عمل.

2. أضِف التبعية التالية إلى إعدادات Gradle أو Maven، مع استبدال العنصر النائب 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" كبيئة تطوير متكاملة.

1. نزّل أحدث إصدار من حزمة SDK للتنقل من Google Drive المشترك وفُك ضغطه. إذا لم تكن لديك إذن الوصول، تواصَل مع ممثّلك.

2. في استوديو Android، افتح مشروعًا وأضِف حزمة خدمات Google Play باستخدام مدير SDK.

3. من دليل ملف zip، انسخ libs/google_navigation_navmap.aar إلى directoryapp/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. 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'
           }
       }
   }
   

ضبط عملية الإنشاء

بعد إنشاء المشروع، يمكنك ضبط الإعدادات لإنشاء واستخدام ناجح لحزمة تطوير البرامج (SDK) للتنقل.

تعديل المواقع المحلية

• في مجلد Gradle Scripts، افتح ملف local.properties وأضف android.useDeprecatedNdk=true.

تعديل النص البرمجي لإنشاء Gradle

• افتح ملف build.gradle (Module:app) واستخدِم الإرشادات التالية لتعديل الإعدادات لاستيفاء متطلبات حزمة تطوير البرامج (SDK) لنظام التنقّل، وفكِّر في ضبط خيارات التحسين أيضًا.

  الإعدادات المطلوبة لحزمة تطوير البرامج (SDK) للتنقّل

  1. اضبط السمة minSdkVersion على 23 أو أعلى.
  2. اضبط targetSdkVersion على 30 أو أكثر.
  3. أضِف إعداد dexOptions يزيد من قيمة javaMaxHeapSize.
  4. يمكنك ضبط مكان المكتبات الإضافية.
  5. أضِف repositories وdependencies لحزمة تطوير البرامج (SDK) للتنقل.
  6. استبدل أرقام الإصدارات في الملحقات بأحدث الإصدارات المتاحة.

  إعدادات اختيارية لتقليل وقت الإنشاء

  • فعِّل تصغير الرموز البرمجية والموارد باستخدام R8/ProGuard لإزالة الرموز البرمجية والموارد غير المستخدَمة من التبعيات. إذا استغرقت خطوة R8/ProGuard وقتًا طويلاً جدًا، يمكنك تفعيل multidex لأعمال التطوير.
  • تقليل عدد ترجمات اللغات المضمّنة في الإصدار: اضبط resConfigs على لغة واحدة أثناء التطوير. في الإصدار النهائي، اضبط resConfigs على اللغات التي تستخدمها فعليًا. يتضمّن Gradle تلقائيًا سلاسل موارد لكل اللغات المتوافقة مع Navigation SDK.

فيما يلي مثال على النص البرمجي لإصدار Gradle للتطبيق. اطّلِع على عيّنات التطبيقات لمعرفة مجموعات التبعيات المعدَّلة، لأنّ إصدار IDE 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. 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'
}

إضافة مفتاح واجهة برمجة التطبيقات إلى تطبيقك

يوضّح هذا القسم طريقة تخزين مفتاح واجهة برمجة التطبيقات كي يتمكّن تطبيقك من الرجوع إليه بشكل آمن. ويجب عدم التحقّق من مفتاح واجهة برمجة التطبيقات في نظام التحكّم في الإصدار، لذا ننصحك بتخزينه في ملف secrets.properties ضمن الدليل الجذري لمشروعك. لمزيد من المعلومات حول ملف secrets.properties، راجِع ملفات خصائص Gradle.

لتبسيط هذه المهمة، ننصحك باستخدام المكوّن الإضافي Secret Gradle لأجهزة Android.

لتثبيت المكوّن الإضافي Secrets Gradle لأجهزة Android في مشروعك على "خرائط Google"، اتّبِع الخطوات التالية:

1. في "استوديو Android"، افتح ملف 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")
       }
   }

   رائع

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

2. افتح الملف 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'
   }

3. في ملف build.gradle.kts أو build.gradle على مستوى الوحدة، تأكَّد من ضبط targetSdk وcompileSdk على 34.
4. احفظ الملف و امزِن مشروعك مع Gradle.
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}" />

   ملاحظة: com.google.android.geo.API_KEY هو اسم البيانات الوصفية المقترَح لمفتاح واجهة برمجة التطبيقات. ويمكن استخدام مفتاح يحمل هذا الاسم للمصادقة على واجهات برمجة تطبيقات متعددة مستندة إلى "خرائط Google" على نظام Android الأساسي، بما في ذلك حزمة "SDK للتنقّل" لنظام التشغيل Android. للتوافق مع الأنظمة القديمة، تتيح واجهة برمجة التطبيقات أيضًا استخدام الاسم com.google.android.maps.v2.API_KEY. لا يسمح هذا الاسم القديم بالمصادقة إلا على الإصدار 2 من واجهة برمجة التطبيقات "خرائط Android". ولا يمكن للتطبيق تحديد سوى اسم واحد فقط من أسماء البيانات الوصفية لمفتاح واجهة برمجة التطبيقات. في حال تحديد الاثنين، تطرح واجهة برمجة التطبيقات استثناءً.

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

    رائع

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

تضمين الإحالات المطلوبة في تطبيقك

إذا كنت تستخدم حزمة SDK للتنقّل لنظام التشغيل Android في تطبيقك، عليك تضمين نص الإحالة وتراخيص البرامج المفتوحة المصدر كجزء من قسم الإشعارات القانونية في تطبيقك.

يمكنك العثور على نص الإحالة المطلوبة وتراخيص البرامج المفتوحة المصدر في حزمة تطوير البرامج (SDK) للتنقل لملف zip لنظام التشغيل Android:

• NOTICE.txt
• LICENSES.txt