يسرد هذا الدليل متطلبات تهيئة الإصدار لاستخدام حزمة SDK للتنقل لنظام Android. تفترض التعليمات أنّ لديك بيئة تطوير متكاملة (IDE) لنظام التشغيل Android وأنّك على دراية بتطوير تطبيقات Android.
الحد الأدنى من متطلبات استخدام حزمة SDK للتنقل
تنطبق هذه المتطلبات على حزمة تطوير البرامج (SDK) الخاصة بالتنقل لنظام التشغيل Android الإصدار 4.99 والإصدارات الأقدم.
مشروع على Google Cloud Console تم تفعيل حزمة تطوير البرامج (SDK) الخاصة به للتنقّل لتوفير المتطلبات اللازمة، يمكنك التواصل مع ممثل "منصة خرائط Google" الذي تتعامل معه.
يجب أن يستهدف تطبيقك المستوى 30 أو أعلى لواجهة برمجة التطبيقات.
لتشغيل تطبيق تم إنشاؤه باستخدام حزمة SDK للتنقل، يجب أن يتم تثبيت خدمات Google Play وتفعيلها على جهاز Android.
يجب إضافة نص الإسناد والترخيص إلى التطبيق.
إعداد مشاريعك: المشروع على Cloud Console ومشروع Android
قبل أن تتمكّن من إنشاء تطبيق أو اختباره، عليك إنشاء مشروع على Cloud Console وإضافة بيانات اعتماد مفتاح واجهة برمجة التطبيقات. يجب أن يتضمن المشروع توفير المتطلبات اللازمة للوصول إلى حزمة SDK للتنقل. يتم منح جميع المفاتيح ضمن مشروع Cloud Console إمكانية الوصول نفسها إلى حزمة SDK للتنقل. يمكن أن يكون للمفتاح أكثر من مشروع تطوير واحد مرتبط به. وإذا كان لديك مشروع على وحدة تحكُّم، يمكنك إضافة مفتاح إلى مشروعك الحالي.
لإعداد الميزة
- في متصفِّح الويب المفضّل لديك، سجِّل الدخول إلى Cloud Console وأنشِئ مشروعك على Cloud Console.
- في IDE، مثل Android Studio، أنشِئ مشروعًا لتطوير تطبيقات Android ولاحظ اسم الحزمة.
- يمكنك التواصل مع ممثل "منصة خرائط Google" لمنحك إذن الوصول إلى حزمة تطوير البرامج (SDK) الخاصة بالتنقّل لمشروعك على Cloud Console.
- من لوحة بيانات Cloud Console في متصفح الويب، يمكنك إنشاء بيانات اعتماد لإنشاء مفتاح واجهة برمجة تطبيقات يتضمّن قيودًا.
- في صفحة مفتاح واجهة برمجة التطبيقات، انقر على "تطبيقات Android" في منطقة قيود التطبيقات.
- انقر على إضافة اسم الحزمة والملف المرجعي، ثم أدخِل اسم حزمة مشروع التطوير والملف المرجعي لخوارزمية SHA-1 لذلك المفتاح.
- انقر على حفظ.
إضافة حزمة SDK للتنقل إلى مشروعك
تتوفّر حزمة تطوير البرامج (SDK) للتنقل من خلال Maven، أو كحزمة AAR. بعد إنشاء مشروع التطوير، يمكنك دمج حزمة SDK فيه باستخدام أحد الأساليب التالية.
استخدام الإصدار 4.5 والإصدارات الأحدث من حزمة تطوير البرامج (SDK) لميزة "التنقل" في Maven (يُنصَح به)
في ما يلي استخدام مستودع Maven في google()
، وهو أبسط الطرق المقترَحة لإضافة حزمة SDK الخاصة بميزة "التنقل" إلى مشروعك.
أضِف التبعية التالية إلى إعداد 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>
استخدام Maven من أجل حزمة تطوير البرامج (SDK) الخاصة بميزة "التنقل" قبل الإصدار 4.5، أو مع Driver SDK
لا تزال حزمة SDK المخصصة للتنقل متاحة عبر مستودع
Maven الأصلي من خلال باقي إصدارات الإصدار 4. وهذه هي المكتبة نفسها التي تتضمّن جميع التحديثات نفسها المتوفّرة في الإصدار أعلاه، وهي توفّر التوافق مع حزمة تطوير البرامج (SDK) لبرنامج Drive والمكتبات الأخرى أثناء عملية النقل. يتطلب استخدام هذه الاعتمادية تسجيل الدخول إلى مشروعك على السحابة الإلكترونية من خلال gcloud
عند تجميع المحتوى.
- يمكنك إعداد بيئتك للوصول إلى مستودع Maven من Google، كما هو موضَّح في قسم المتطلبات الأساسية ضمن مستندات حزمة تطوير البرامج (SDK) للمستهلك. ويتم التحكّم في إمكانية الوصول إلى حزمة تطوير البرامج (SDK) للتنقّل من خلال مجموعة مساحة عمل.
أضِف التبعية التالية إلى إعداد 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" لبيئة التطوير المتكاملة.
نزّل أحدث إصدار من حزمة SDK للتنقل من Google Drive المشترك وفك ضغطه. وإذا لم تتمكّن من الوصول إليه، يُرجى التواصل مع الممثّل.
في استوديو Android، افتح مشروعًا وأضِف حزمة خدمات Google Play باستخدام مدير 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' } } }
ضبط الإصدار
بعد إنشاء المشروع، يمكنك تهيئة الإعدادات لإنشاء إصدار ناجح واستخدام حزمة SDK للتنقل.
تعديل المواقع المحلية
- في مجلد نصوص Gradle البرمجية، افتح ملف
local.properties
وأضِفandroid.useDeprecatedNdk=true
.
تعديل النص البرمجي لإنشاء Gradle
افتح ملف
build.gradle (Module:app)
واستخدم الإرشادات التالية لتحديث الإعدادات لاستيفاء متطلبات حزمة SDK للتنقل ومراعاة إعداد خيارات التحسين أيضًا.الإعدادات المطلوبة لحزمة تطوير البرامج (SDK) الخاصة بالتنقل
- يجب ضبط
minSdkVersion
على 23 أو أعلى. - يجب ضبط
targetSdkVersion
على 30 أو أعلى. - أضِف إعداد
dexOptions
يزيد منjavaMaxHeapSize
. - عيِّن الموقع للمكتبات الإضافية.
- أضِف
repositories
وdependencies
لحزمة تطوير البرامج (SDK) الخاصة بالتنقل. - استبدل أرقام الإصدارات في التبعيات بأحدث الإصدارات المتاحة.
الإعدادات الاختيارية لتقليل وقت الإصدار
- تفعيل تقليص الرموز وتقليص الموارد باستخدام R8/ProGuard لإزالة الرموز والموارد غير المستخدمة من التبعيات. إذا استغرق تنفيذ خطوة R8/ProGuard وقتًا طويلاً، ننصحك بتفعيل multidex لأعمال التطوير.
- تقليل عدد ترجمات اللغات المضمّنة في الإصدار: اضبط
resConfigs
للغة واحدة أثناء عملية التطوير. وفي الإصدار النهائي، اضبطresConfigs
على اللغات التي تستخدمها حاليًا. بشكل افتراضي، تتضمن Gradle سلاسل الموارد لجميع اللغات التي تدعمها حزمة SDK للتنقل.
- يجب ضبط
في ما يلي مثال على نص برمجي لإنشاء 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.
لتبسيط هذه المهمة، ننصحك باستخدام المكوّن الإضافي Secret Gradle الإضافي لنظام Android.
لتثبيت المكوّن الإضافي Secret Gradle الإضافي لنظام التشغيل Android في مشروع "خرائط Google"، اتَّبِع الخطوات التالية:
-
في "استوديو 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") } }
-
افتح ملف
build.gradle
على مستوى الوحدة وأضِف الرمز التالي إلى العنصرplugins
.رائع
plugins { // ... id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' }
Kotlin
plugins { id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") }
- في ملف
build.gradle
على مستوى الوحدة، تأكَّد من ضبطtargetSdk
وcompileSdk
على 34. - احفظ الملف وزامِن مشروعك مع Gradle.
-
افتح ملف
secrets.properties
في دليل المستوى الأعلى، ثم أضِف الرمز التالي. استبدِلYOUR_API_KEY
بمفتاح واجهة برمجة التطبيقات. يمكنك تخزين مفتاحك في هذا الملف لأنّه تم استبعادsecrets.properties
من التسجيل في نظام التحكّم في الإصدار.MAPS_API_KEY=YOUR_API_KEY
- احفظ الملف.
-
أنشِئ ملف
local.defaults.properties
في دليل المستوى الأعلى، أي الملف نفسه الذي يتضمّن ملفsecrets.properties
، ثم أضِف الرمز التالي.MAPS_API_KEY=DEFAULT_API_KEY
الغرض من هذا الملف هو توفير موقع جغرافي احتياطي لمفتاح واجهة برمجة التطبيقات في حال عدم العثور على ملف
secrets.properties
لكي لا تفشل الإصدارات. وقد يحدث ذلك في حال استنساخ التطبيق من نظام تحكّم في الإصدارات يستبعدsecrets.properties
ولم تنشئ بعد ملفsecrets.properties
على الجهاز لتوفير مفتاح واجهة برمجة التطبيقات الخاص بك. - احفظ الملف.
-
في ملف
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 namecom.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
orbuild.gradle.kts
file and edit thesecrets
property. If thesecrets
property does not exist, add it.Edit the properties of the plugin to set
propertiesFileName
tosecrets.properties
, setdefaultPropertiesFileName
tolocal.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 للتنقّل في Android لنظام التشغيل Android:
NOTICE.txt
LICENSES.txt
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2024-03-15 (حسب التوقيت العالمي المتفَّق عليه)
[{ "type": "thumb-down", "id": "missingTheInformationINeed", "label":"لا يحتوي على المعلومات التي أحتاج إليها." },{ "type": "thumb-down", "id": "tooComplicatedTooManySteps", "label":"الخطوات معقدة للغاية / كثيرة جدًا." },{ "type": "thumb-down", "id": "outOfDate", "label":"المحتوى قديم." },{ "type": "thumb-down", "id": "translationIssue", "label":"ثمة مشكلة في الترجمة." },{ "type": "thumb-down", "id": "samplesCodeIssue", "label":"مشكلة في العيّنات / التعليمات البرمجية" },{ "type": "thumb-down", "id": "otherDown", "label":"غير ذلك" }] [{ "type": "thumb-up", "id": "easyToUnderstand", "label":"يسهُل فهم المحتوى." },{ "type": "thumb-up", "id": "solvedMyProblem", "label":"ساعَدني المحتوى في حلّ مشكلتي." },{ "type": "thumb-up", "id": "otherUp", "label":"غير ذلك" }]