כדי להגדיר את מסוף Google Cloud ולהשתמש בו ב-SDK לצרכנים ל-Android, פועלים לפי השלבים הבאים.
- מגדירים פרויקט פיתוח.
- מוסיפים את Consumer SDK לאפליקציה.
- מוסיפים את מפתח ה-API לאפליקציה.
- כוללים את השיוך הנדרש באפליקציה.
פרטים נוספים על כל שלב מופיעים בסעיפים הבאים.
הגדרת פרויקט הפיתוח
אם אין לכם פרויקט פיתוח במסוף Google Cloud ומפתח API לפרויקט שלכם בתחום התחבורה, תצטרכו להגדיר אותם. פרטים נוספים זמינים בקטע יצירת פרויקט במדריך של Fleet Engine.
כשבוחרים את פרויקט הפיתוח של Consumer SDK, צריך לבחור את אותו פרויקט ומפתח API במסוף Google Cloud שבו משתמשים ב-Fleet Engine.
הוספת ה-SDK לצרכנים לאפליקציה
ערכת ה-SDK לצרכן זמינה במאגר Maven של Google. המאגר כולל את קובצי ה-Project Object Model (.pom) ואת קובצי ה-Javadoc של ה-SDK. כדי להוסיף את Consumer SDK לאפליקציה, צריך להוסיף את יחסי התלות של Consumer SDK ו-Maps SDK להגדרות של Gradle או Maven.
בדוגמאות הבאות, מחליפים את VERSION_NUMBER
בגרסת ה-SDK הנדרשת של הצרכן:
Gradle
מוסיפים את הפרטים הבאים לקובץ build.gradle
:
dependencies {
...
implementation 'com.google.android.libraries.mapsplatform.transportation:transportation-consumer:VERSION_NUMBER'
implementation "com.google.android.gms:play-services-maps:18.1.0"
}
Maven
מוסיפים את הפרטים הבאים לקובץ pom.xml
:
<dependencies>
...
<dependency>
<groupId>com.google.android.libraries.mapsplatform.transportation</groupId>
<artifactId>transportation-consumer</artifactId>
<version>VERSION_NUMBER</version>
</dependency>
<dependency>
<groupId>com.google.android.gms</groupId>
<artifactId>play-services-maps</artifactId>
<version>18.1.0</version>
</dependency>
</dependencies>
הוספה של מפתח ה-API לאפליקציה
אחרי שמוסיפים לאפליקציה את ה-SDK לצרכנים, מוסיפים את מפתח ה-API. עליכם להשתמש במפתח ה-API של הפרויקט שקיבלתם כשהגדרתם את פרויקט הפיתוח. לפרטים נוספים, ראו הגדרת פרויקט הפיתוח בשלב 3 של המדריך.
בקטע הזה מוסבר איך לאחסן את מפתח ה-API כך שהאפליקציה תוכל להפנות אליו בצורה מאובטחת יותר. מידע נוסף על השיטות המומלצות לאבטחת מפתחות API זמין במאמר שיטות מומלצות לאבטחת API בפלטפורמה של מפות Google.
כדי לייעל את המשימה הזו, תוכלו להיעזר במאמרי העזרה של GitHub על פלאגין של Secrets Gradle ל-Android.
כדי להתקין את הפלאגין ולאחסן את מפתח ה-API:
פותחים את קובץ
build.gradle
ברמה הבסיסית (root) ומוסיפים את הקוד הבא לרכיבdependencies
בקטעbuildscript
.מגניב
buildscript { dependencies { // ... classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.0" } }
Kotlin
buildscript { dependencies { // ... classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.0") } }
פותחים את הקובץ
build.gradle
ברמת האפליקציה ומוסיפים את הקוד הבא לרכיבplugins
.Groovy
id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
Kotlin
id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
אם אתם משתמשים ב-Android Studio, עליכם לסנכרן את הפרויקט עם Gradle. למידע נוסף, ראו סנכרון הפרויקט עם Gradle במסמכי העזרה של Android.
פותחים את
local.properties
בספרייה ברמת הפרויקט ומוסיפים את הקוד הבא. מחליפים את הערךYOUR_API_KEY
במפתח ה-API שלכם.MAPS_API_KEY=YOUR_API_KEY
בקובץ
AndroidManifest.xml
, עוברים אלcom.google.android.geo.API_KEY
ומעדכנים את המאפייןandroid:value
באופן הבא:
<meta-data
android:name="com.google.android.geo.API_KEY"
android:value="${MAPS_API_KEY}" />
בדוגמה הבאה מוצג מניפסט מלא של אפליקציה לדוגמה:
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.consumerapidemo">
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<application
android:allowBackup="true"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:supportsRtl="true"
android:theme="@style/_AppTheme">
<meta-data
android:name="com.google.android.geo.API_KEY"
android:value="${MAPS_API_KEY}" />
<activity android:name=".MainActivity">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
</application>
</manifest>
לכלול את הייחוסים הנדרשים באפליקציה
אם אתם משתמשים ב-Consumer SDK באפליקציה, עליכם לכלול את טקסט השיוך ואת הרישיונות של קוד פתוח בקטע של ההודעות המשפטיות באפליקציה. מומלץ לכלול את הקרדיטים כפריט תפריט עצמאי או כחלק מפריט התפריט מידע על.
פרטי הרישיון מופיעים בקובץ third_party_licenses.txt בקובץ ה-AAR שלא עבר ארכיון.
במאמר https://developers.google.com/android/guides/opensource מוסבר איך מוסיפים הודעות לגבי קוד פתוח.