הגדרת פרויקט במסוף Google Cloud

כדי להגדיר את מסוף Google Cloud כך שישתמש ב-Consumer SDK ל-Android, פועלים לפי השלבים הבאים.

1. הגדרת פרויקט הפיתוח
2. מוסיפים את Consumer SDK לאפליקציה.
3. הוספת מפתח ה-API לאפליקציה
4. מוסיפים את הקרדיטים הנדרשים לאפליקציה.

בסעיפים הבאים יש מידע נוסף על כל שלב.

הערה: האפליקציה חייבת לטרגט ל-minSdkVersion 23 ומעלה.

הגדרת פרויקט הפיתוח

אם אין לכם פרויקט פיתוח במסוף Google Cloud ומפתח API לפרויקט הניידות שלכם, אתם צריכים להגדיר אחד. פרטים נוספים זמינים במאמר יצירת פרויקט במדריך Fleet Engine.

כשבוחרים את פרויקט הפיתוח עבור Consumer SDK, צריך לבחור את אותו פרויקט ב-Google Cloud Console ואת אותו מפתח API שבהם משתמשים ב-Fleet Engine.

הוספת Consumer SDK לאפליקציה

ערכת ה-SDK לצרכנים זמינה במאגר Google Maven. המאגר כולל את קובצי Project Object Model ‏ (.pom) של ה-SDK ואת Javadocs. כדי להוסיף את Consumer SDK לאפליקציה, צריך להוסיף את התלות של Consumer SDK ו-Maps SDK להגדרות של Gradle או Maven.

הערה: Consumer SDK תלוי ב-Maps SDK. צריך להגדיר את התלות בגרסה מוגדרת במפורש של Maps SDK, כמו בדוגמה הזו. אחרת, Consumer SDK משתמש בגרסה המינימלית הנדרשת של Maps SDK, מה שעלול לגרום לבעיות אם האפליקציה שלכם מסתמכת על תכונות שזמינות בגרסאות מאוחרות יותר של Maps SDK.

בדוגמאות הבאות, מחליפים את VERSION_NUMBER בגרסה הנדרשת של Consumer 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 לאפליקציה

אחרי שמוסיפים את Consumer SDK לאפליקציה, מוסיפים את מפתח ה-API. אתם צריכים להשתמש במפתח ה-API של הפרויקט שקיבלתם כשהגדרתם את פרויקט הפיתוח. פרטים נוספים זמינים במאמר הגדרת פרויקט הפיתוח בשלב 3 במדריך הזה.

בקטע הזה מוסבר איך לאחסן את מפתח ה-API כדי שהאפליקציה תוכל להפנות אליו בצורה מאובטחת יותר. למידע נוסף על שיטות מומלצות לאבטחת מפתחות API, אפשר לעיין במאמר בנושא שיטות מומלצות לאבטחת API בפלטפורמה של מפות Google.

חשוב: אל תכניסו את מפתח ה-API למערכת בקרת הגרסאות. במקום זאת, מאחסנים אותו בקובץ local.properties, שנמצא בספריית השורש של הפרויקט. מידע נוסף על הקובץ local.properties זמין במאמר קובצי מאפיינים של Gradle.

כדי לייעל את המשימה הזו, אפשר להשתמש במסמכי התיעוד של GitHub בנושא Secrets Gradle Plugin for Android.

כדי להתקין את הפלאגין ולאחסן את מפתח ה-API:

1. פותחים את קובץ build.gradle ברמת הבסיס ומוסיפים את הקוד הבא לרכיב 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")
       }
   }
   

2. פותחים את קובץ build.gradle ברמת האפליקציה ומוסיפים את הקוד הבא לרכיב plugins.

   גרוב

   id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
   

   Kotlin

   id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
   

3. אם משתמשים ב-Android Studio, מסנכרנים את הפרויקט עם Gradle. פרטים נוספים זמינים במאמר סנכרון הפרויקט עם Gradle בתיעוד של Android.

4. פותחים את local.properties בספרייה ברמת הפרויקט ומוסיפים את הקוד הבא. מחליפים את הערך YOUR_API_KEY במפתח ה-API שלכם.

   MAPS_API_KEY=YOUR_API_KEY

5. בקובץ 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 מוסבר איך לכלול הודעות על קוד פתוח.

המאמרים הבאים

קבלת טוקנים של אימות