הגדרת פרויקט במסוף 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 ואת אותו מפתח API שמשמשים ל-Fleet Engine.

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

ערכת ה-SDK לצרכן זמינה במאגר Maven של Google. המאגר כולל את קובצי 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 זמין במאמר של Google Maps Platform בנושא שיטות מומלצות לאבטחת ממשקי API.

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

כדי לייעל את המשימה הזו, אתם יכולים להשתמש בפלאגין Secrets Gradle ל-Android שמתואר במסמכי התיעוד של GitHub.

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

1. פותחים את הקובץ 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")
       }
   }
   

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

   Groovy

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

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

קבלת אסימוני אימות