إعداد مشروعك

يسرد هذا الدليل متطلبات تهيئة الإصدار لاستخدام حزمة SDK للتنقل للإصدار 5.0.0 والإصدارات الأحدث من نظام التشغيل Android.

تفترض التعليمات أن لديك برنامج Android IDE مثبت وأنك على دراية بتطوير Android.

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

تسري هذه المتطلبات على حزمة تطوير البرامج (SDK) للتنقل للإصدار 5.0.0 من نظام التشغيل Android والإصدارات الأحدث.

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

• يجب أن يحدِّد تطبيقك إصدارات Android على النحو التالي:

  • يجب أن يكون الإصدار المستهدف هو Android 13 (المستوى 33 لواجهة برمجة التطبيقات) أو إصدارًا أحدث.
  • يجب أن يكون الحدّ الأدنى من الإصدار هو Android 6 (المستوى 23 من واجهة برمجة التطبيقات) أو الإصدارات الأحدث.

• لتشغيل تطبيق تم إنشاؤه باستخدام حزمة SDK للتنقل، يجب أن يلبي جهاز Android المتطلبات التالية:

  • تم تثبيت خدمات Google Play وتفعيلها.

  • ذاكرة وصول عشوائي (RAM) بسعة 2 غيغابايت أو أكثر.

  • دعم OpenGL ES 2.0. يُرجى الاطّلاع على مستندات التوافق مع الإصدار Android 6.0 من نظام التشغيل Android المفتوحة المصدر للتعرّف على تسريع الرسومات الثنائية والثلاثية الأبعاد.

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

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

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

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

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. بعد إنشاء مشروع التطوير، يمكنك دمج SDK فيه باستخدام أحد الأساليب التالية.

استخدام الإصدار 4.5 من حزمة تطوير البرامج (SDK) لأداة التنقّل في Maven والإصدارات الأحدث (يُنصح به)

يتم استخدام مستودع 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 لخرائط 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>
   

ضبط الإصدار

بعد إنشاء المشروع، يمكنك ضبط الإعدادات لإنشاء واستخدام ناجح لحزمة تطوير البرامج (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

  • إذا كنت تنشئ تطبيقك باستخدام الإصدار 4.0.0 من المكوّن الإضافي لنظام Gradle المتوافق مع Android أو الإصدارات الأحدث، سيمنح المكوّن الإضافي الدعم اللازم لاستخدام عدد من واجهات برمجة التطبيقات بلغة 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.

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

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

1. في "استوديو Android"، افتح ملف 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. احفظ الملف وزامن مشروعك مع Gradle.
5. افتح ملف secrets.properties في دليل المستوى الأعلى، ثم أضِف الرمز التالي. استبدِل YOUR_API_KEY بمفتاح واجهة برمجة التطبيقات الخاص بك. عليك تخزين مفتاحك في هذا الملف لأنّه تم استبعاد secrets.properties من التحقق من الوصول إلى نظام التحكم في الإصدار.

   MAPS_API_KEY=YOUR_API_KEY

6. احفظ الملف.

7. أنشِئ ملف local.defaults.properties في دليل المستوى الأعلى والمجلد نفسه الذي يتضمّن ملف secrets.properties، ثم أضِف الرمز التالي.

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

إدراج عمليات تحديد المصدر المطلوبة في تطبيقك

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

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

• NOTICE.txt
• LICENSES.txt