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

يسرد هذا الدليل متطلبات ضبط الإصدار لاستخدام حزمة SDK للتنقل لنظام التشغيل Android تفترض التعليمات أنّ لديك بيئة تطوير متكاملة (IDE) لنظام التشغيل Android التثبيت ويعرفون كيفية تطوير برامج Android.

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

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

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

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

  • لتشغيل تطبيق تم إنشاؤه باستخدام حزمة SDK للتنقل، يمكن لنظام أن يكون جهازك مزوّدًا بخدمات Google Play تثبيته وتمكينه.

  • نص عمليات تحديد المصدر والترخيص يجب إضافته إلى التطبيق.

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

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

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

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

إضافة حزمة SDK للتنقّل إلى مشروعك

تتوفر حزمة SDK للتنقل عبر Maven أو حزمة AAR: بعد إنشاء مشروع التطوير، يمكنك دمج 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 لخرائط Google، فيجب عليك استبعاد في كل اعتمادية معلَن عنها تعتمد على حزمة تطوير البرامج بالاستناد إلى بيانات "خرائط 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 للحزمة SDK قبل الإصدار 4.5 أو مع Driver SDK

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

  1. يمكنك إعداد بيئتك للوصول إلى مستودع Maven من Google كما هو موضّح في المتطلّبات الأساسية قسم وثائق حزمة SDK للمستهلكين. يمكنك الوصول إلى يتم التحكّم في حزمة تطوير البرامج (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، فيجب عليك استبعاد في كل اعتمادية معلَن عنها تعتمد على حزمة تطوير البرامج بالاستناد إلى بيانات "خرائط 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 للتنقل أيضًا باعتبارها حزمة AAR. بعد إنشاء مشروع التطوير، يمكنك دمج حزمة SDK. هذه التعليمات ستفترض استخدام "استوديو Android" في بيئة التطوير المتكاملة (IDE).

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

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

  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. 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 سلاسل الموارد لكل اللغات التي توفِّرها حزمة تطوير البرامج للتنقل

فيما يلي مثال على النص البرمجي لإصدار 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'
}

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

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

لتبسيط هذه المهمة، نوصيك باستخدام المكوّن الإضافي السري لنظام 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")
    }
}

    Groovy

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

    Groovy

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

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

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

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

يمكنك العثور على نص المصدر المطلوب وتراخيص البرامج المفتوحة المصدر في حزمة SDK للتنقل لملف Android المضغوط:

  • NOTICE.txt
  • LICENSES.txt