כדי להגדיר את מסוף Google Cloud ולהגדיר בו שימוש ב-Consumer SDK ל-Android, פועלים לפי השלבים הבאים.
- מגדירים את פרויקט הפיתוח.
- מוסיפים את Consumer SDK לאפליקציה.
- מוסיפים את מפתח ה-API לאפליקציה.
- כוללים את השיוך הנדרש באפליקציה.
פרטים נוספים על כל שלב מופיעים בקטעים הבאים.
הגדרת פרויקט הפיתוח
אם אין לכם פרויקט פיתוח במסוף Google Cloud ומפתח API לפרויקט שלכם בתחום התחבורה, תצטרכו להגדיר פרויקט כזה. פרטים נוספים זמינים בקטע יצירת פרויקט במדריך של Fleet Engine.
כשבוחרים את פרויקט הפיתוח של Consumer SDK, צריך לבחור את אותו פרויקט ומפתח API במסוף Google Cloud שבו אתם משתמשים ב-Fleet Engine.
הוספת Consumer 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
ברמת הבסיס ומוסיפים את הקוד הבא לאלמנטdependencies
בקטעbuildscript
.Groovy
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 מוסבר איך לכלול הודעות על קוד פתוח.