בדף הזה נסביר איך להגדיר בפרויקט Android Studio להשתמש ב-SDK של מפות Google ל-Android בלי להשתמש בתבנית של מפות Google שמפורטת במדריך למתחילים.
התבנית של מפות Google מגדירה באופן אוטומטי מפה בסיסית ומוסיפה אותה לפרויקט חדש ב-Android Studio. עם זאת, אפשר גם להוסיף מפה לפרויקט Android עם תבנית אחרת של Android Studio. כדי לעשות זאת, צריך להגדיר את הפרויקט באופן ידני ואז להוסיף את המפה.
שלב 1: הגדרת Android Studio
במסמך הזה מתוארת סביבת פיתוח באמצעות Android Studio Hdgehog והפלאגין של Android Gradle גרסה 8.2.
שלב 2. הגדרת ה-SDK
ה-SDK של מפות Google ל-Android זמין דרך מאגר Maven של Google. כדי להוסיף את ה-SDK לאפליקציה:
- בקובץ
settings.gradle
ברמה העליונה, כוללים את פורטל הפלאגין של Gradle, את המאגר של Google Maven ואת המאגר המרכזי של Maven בקטעpluginManagement
. הבלוקpluginManagement
חייב להופיע לפני כל הצהרה אחרת בסקריפט.pluginManagement { repositories { gradlePluginPortal() google() mavenCentral() } }
- בקובץ
settings.gradle
ברמה העליונה, כוללים את מאגר Maven של Google ואת המאגר המרכזי של Maven בבלוקdependencyResolutionManagement
:dependencyResolutionManagement { repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) repositories { google() mavenCentral() } }
- בקובץ
build.gradle
ברמת המודול, מוסיפים את התלות של Google Play Services ב-SDK של מפות Google ל-Android.מגניב
dependencies { // Maps SDK for Android implementation 'com.google.android.gms:play-services-maps:19.0.0' }
Kotlin
dependencies { // Maps SDK for Android implementation("com.google.android.gms:play-services-maps:18.2.0") }
- בקובץ
build.gradle
ברמת המודול, מגדירים אתcompileSdk
ואתminSdk
לערכים הבאים:מגניב
android { compileSdk 34 defaultConfig { minSdk 21 // ... } }
Kotlin
android { compileSdk = 34 defaultConfig { minSdk = 21 // ... } }
- בקטע
buildFeatures
בקובץbuild.gradle
ברמת המודול, מוסיפים את המחלקהBuildConfig
, שבעזרתה ניתן לגשת לערכי המטא-נתונים שמוגדרים בהמשך התהליך הזה:מגניב
android { // ... buildFeatures { buildConfig true // ... } }
Kotlin
android { // ... buildFeatures { buildConfig = true // ... } }
שלב 3: מוסיפים את מפתח ה-API לפרויקט
בקטע הזה נסביר איך לאחסן את מפתח ה-API כדי שהאפליקציה תוכל להפנות אליו באופן מאובטח. אסור לבדוק את מפתח ה-API במערכת לניהול גרסאות. לכן מומלץ לשמור אותו בקובץ secrets.properties
, שנמצא בתיקיית השורש של הפרויקט. למידע נוסף על הקובץ secrets.properties
ראו קובצי מאפייני Gradle.
כדי לייעל את המשימה הזו, מומלץ להשתמש בפלאגין של Secrets Gradle ל-Android.
כדי להתקין את הפלאגין Secrets Gradle ל-Android בפרויקט במפות Google:
-
ב-Android Studio, פותחים את הקובץ
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
במפתח ה-API שלכם. אפשר לאחסן את המפתח בקובץ הזה כי הבדיקה שלsecrets.properties
לא נכללת במערכת לניהול גרסאות.MAPS_API_KEY=YOUR_API_KEY
- שומרים את הקובץ.
-
יוצרים את הקובץ
local.defaults.properties
בספרייה שברמה העליונה, את אותה התיקייה שבה נמצא הקובץsecrets.properties
, ואז מוסיפים את הקוד הבא.MAPS_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 Maps 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.*" }
שלב 4: עדכון קובץ המניפסט של האפליקציה
בקטע הזה מתוארות ההגדרות שצריך להוסיף לקובץ
AndroidManifest.xml
.מספר הגרסה של Google Play Services
צריך להוסיף את ההצהרה הבאה בתוך הרכיב
application
. בגרסה הזו מוטמעת הגרסה של Google Play Services שאיתה בוצעה הידור של האפליקציה.<meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version" />
הרשאת מיקום
אם האפליקציה שלכם צריכה גישה למיקום של המשתמש, אתם צריכים לבקש את הרשאת המיקום בקובץ
AndroidManifest.xml
. האפשרויות הןACCESS_FINE_LOCATION
, שמספקת את המיקום המדויק של המכשיר, ו-ACCESS_COARSE_LOCATION
, פחות מדויקת. למידע נוסף, עיינו במדריך נתוני מיקום.כדי לבקש הרשאה ל-
ACCESS_FINE_LOCATION
, מוסיפים את הקוד הבא לרכיבmanifest
:<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
הרשאה לניהול אחסון חיצוני
אם אתם מטרגטים גרסה 8.3 ואילך של Google Play Services SDK, אין צורך בהרשאה
WRITE_EXTERNAL_STORAGE
. אם אתם מטרגטים גרסאות קודמות של Google Play Services SDK, אתם צריכים לבקש את ההרשאה WRITE_EXTERNAL_STORAGE ברכיבmanifest
.<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
ספריית Apache HTTP מדור קודם
אם משתמשים ב-
com.google.android.gms:play-services-maps:16.0.0
ומטה והאפליקציה מטרגטת רמת API 28 (Android 9.0) ואילך, צריך לכלול את ההצהרה הבאה ברכיב<application>
שלAndroidManifest.xml
. אחרת, אפשר לדלג על ההצהרה הזו.<uses-library android:name="org.apache.http.legacy" android:required="false" />
שלב 5: הגדרת מכשיר Android
כדי להפעיל אפליקציה שמשתמשת ב-SDK של מפות Google ל-Android, צריך לפרוס אותה במכשיר Android או באמולטור Android שמבוסס על Android 5.0 ואילך וכולל את ממשקי Google API.
- כדי להשתמש במכשיר Android, צריך לפעול לפי ההוראות במאמר הפעלת אפליקציות במכשיר חומרה.
- כדי להשתמש באמולטור Android, אפשר ליצור מכשיר וירטואלי ולהתקין את האמולטור באמצעות מנהל המכשיר הווירטואלי (AVD) של Android שכלול ב-Android Studio.
שלב 6: (אופציונלי) בודקים אם יש תמיכה ב-Play Service
כדי להשתמש ב-SDK של מפות Google ל-Android, צריך להתקין את Google Play Services במכשיר שבו פורסים את האפליקציה. Google מספקת שיטה שמאפשרת לבצע קריאה מהאפליקציה כדי לבדוק. למידע נוסף, קראו את המאמר בדיקה אם Google Play Services מותקנת.
השלבים הבאים
אחרי שמגדירים את הפרויקט, אפשר להוסיף מפה.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2024-07-13 (שעון UTC).
[] []