איך מגדירים פרויקט Android Studio

כדי להגדיר את האפליקציה לשימוש ב- Places SDK ל-Android, בצעו את השלבים הבאים. הן נדרשות לכל האפליקציות שמשתמשות ב- Places SDK ל-Android.

שלב 1: הגדרת Android Studio

  1. נדרשת גרסת Android Studio Arctic Fox ואילך. אם עדיין לא עשית זאת, מורידים ומתקינים אותו.
  2. מוודאים שמשתמשים בפלאגין של Android Gradle בגרסה 7.0 ואילך ב-Android Studio.

שלב 2. הגדרת ה-SDK

ספריית Places SDK ל-Android זמינה דרך מאגר Maven של Google. כדי להוסיף את ה-SDK לאפליקציה:

  1. בקובץ settings.gradle ברמה העליונה, כוללים את פורטל יישומי הפלאגין של Gradle, את מאגר Google Maven ואת המאגר המרכזי של Maven בבלוק pluginManagement. הבלוק pluginManagement חייב להופיע לפני כל הצהרה אחרת בסקריפט.
    pluginManagement {
        repositories {
            gradlePluginPortal()
            google()
            mavenCentral()
        }
    } 
  2. בקובץ settings.gradle ברמה העליונה, כוללים את מאגר Maven של Google ואת המאגר המרכזי של Maven מתחת לקטע dependencyResolutionManagement:
    dependencyResolutionManagement {
        repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
        repositories {
            google()
            mavenCentral()
        }
    } 
  3. בקטע dependencies בקובץ build.gradle ברמת המודול, מוסיפים תלות ב- Places SDK ל-Android:

    dependencies {
        implementation 'com.google.android.libraries.places:places:3.3.0'
    }
    
  4. בקובץ build.gradle ברמת המודול, מגדירים את compileSdk ואת minSdk לערכים הבאים:
    android {
        compileSdk 31
    
        defaultConfig {
            minSdk 21
            // ...
        }

שלב 3: מוסיפים את מפתח ה-API לפרויקט

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

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

כדי להתקין את הפלאגין Secrets Gradle ל-Android בפרויקט מפות Google:

  1. ב-Android Studio, פותחים את הקובץ build.gradle ברמת הפרויקט ומוסיפים את הקוד הבא לרכיב dependencies בקטע buildscript.

    מגניב

    buildscript {
        dependencies {
            classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
        }
    }

    Kotlin

    buildscript {
        dependencies {
            classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
        }
    }
    
  2. פותחים את הקובץ build.gradle ברמת המודול ומוסיפים את הקוד הבא לרכיב plugins.

    מגניב

    plugins {
        // ...
        id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
    }

    Kotlin

    plugins {
        id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
    }
  3. שומרים את הקובץ ומסנכרנים את הפרויקט עם Gradle.
  4. פותחים את secrets.properties בספרייה ברמת הפרויקט ומוסיפים את הקוד הבא. מחליפים את הערך YOUR_API_KEY במפתח ה-API שלכם.
    MAPS_API_KEY=YOUR_API_KEY 
  5. שומרים את הקובץ.
  6. בקובץ AndroidManifest.xml, עוברים אל com.google.android.geo.API_KEY ומעדכנים את android:value attribute באופן הבא:
    <meta-data
        android:name="com.google.android.geo.API_KEY"
        android:value="${MAPS_API_KEY}" />
  7. אפשר לערוך את מאפייני הפלאגין כדי לציין קובץ סודות אחר או מאפיינים אחרים. ב-Android Studio, פותחים את הקובץ build.gradle ברמת הפרויקט ועורכים את הנכס secrets:

    secrets {
        // Optionally specify a different file name containing your secrets.
        // The plugin defaults to "local.properties"
        propertiesFileName = "secrets.properties"
    
        // A properties file containing default secret values. This file can be
        // checked in version control.
        defaultPropertiesFileName = 'local.defaults.properties'
    
        // Configure which keys should be ignored by the plugin by providing regular expressions.
        // "sdk.dir" is ignored by default.
        ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore"
        ignoreList.add("sdk.*")       // Ignore all keys matching the regexp "sdk.*"
    }

הערה: כפי שמתואר למעלה, com.google.android.geo.API_KEY הוא השם המומלץ של המטא-נתונים למפתח ה-API. מפתח בשם זה יכול לשמש לאימות במספר ממשקי API המבוססים על מפות Google בפלטפורמת Android, כולל Places SDK ל-Android. לצורך תאימות לאחור, ה-API תומך גם בשם com.google.android.maps.v2.API_KEY. השם הקודם מאפשר אימות ב-Android Maps API v2 בלבד. אפליקציה יכולה לציין רק אחד מהשמות של המטא-נתונים של מפתח ה-API. אם שניהם צוינו, ה-API יחריג חריג.

שלב 4. אתחול הלקוח של Places API

יש להפעיל את Places SDK ל-Android בתוך פעילות או מקטע. תחילה עליכם להחליט באיזו גרסה של ה-SDK להשתמש: Places SDK ל-Android או Places SDK ל-Android (חדש). למידע נוסף על גרסאות של מוצרים, קראו את המאמר בחירה של גרסת ה-SDK.

הדוגמה הבאה מראה איך להפעיל את ה-SDK בשתי הגרסאות.

Places SDK ל-Android (חדש)

מעבירים את מפתח ה-API כשמפעילים את Places.initializeWithNewPlacesApiEnabled():

Kotlin

    // Initialize the SDK
    Places.initializeWithNewPlacesApiEnabled(applicationContext, apiKey)

    // Create a new PlacesClient instance
    val placesClient = Places.createClient(this)
    

Java

    // Initialize the SDK
    Places.initializeWithNewPlacesApiEnabled(getApplicationContext(), apiKey);

    // Create a new PlacesClient instance
    PlacesClient placesClient = Places.createClient(this);
    

SDK של מקומות ל-Android

מעבירים את מפתח ה-API כשמפעילים את Places.initialize():

Kotlin



    // Initialize the SDK
    Places.initialize(applicationContext, apiKey)

    // Create a new PlacesClient instance
    val placesClient = Places.createClient(this)

      

Java


    // Initialize the SDK
    Places.initialize(getApplicationContext(), apiKey);

    // Create a new PlacesClient instance
    PlacesClient placesClient = Places.createClient(this);

      

עכשיו אתה מוכן להתחיל להשתמש ב- Places SDK ל-Android!

שלב 5: הגדרה של מכשיר Android

כדי להפעיל אפליקציה שמשתמשת ב- Places SDK ל-Android, צריך לפרוס אותה במכשיר Android או באמולטור Android המבוסס על Android 4.0 ואילך וכולל את Google APIs.

  • כדי להשתמש במכשיר Android, צריך לפעול לפי ההוראות במאמר הפעלת אפליקציות בחומרה.
  • כדי להשתמש באמולטור של Android, אפשר ליצור מכשיר וירטואלי ולהתקין אותו באמצעות מנהל המכשירים הווירטואליים (AVD) של Android שכלול ב-Android Studio.

השלבים הבאים

אחרי הגדרת הפרויקט, תוכלו לעיין באפליקציות לדוגמה.