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

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

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

פרטים נוספים על כל שלב מופיעים בקטעים הבאים.

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

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

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

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

ה-SDK של הצרכן זמין במאגר Maven של Google. המאגר כולל את קובצי ה-Project Object Model (‎.pom) ואת קובצי ה-Javadoc של ה-SDK. כדי להוסיף את Consumer SDK לאפליקציה, מוסיפים את יחסי התלות של Consumer SDK ו-Maps SDK להגדרות של Gradle או Maven.

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

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

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

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

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

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

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