راه‌اندازی پروژه «استودیو Android»

برای پیکربندی کردن برنامه‌تان برای استفاده از «کیت توسعه نرم‌افزار مکان‌ها ویژه Android»، این مراحل را دنبال کنید. این مجوزها برای همه برنامه‌هایی که از «کیت توسعه نرم‌افزار مکان‌ها ویژه Android» استفاده می‌کنند الزامی است.

مرحله ۱: راه‌اندازی Android Studio

این سند محیط توسعه‌ای را بااستفاده از Android Studio Hedgehog و افزایه Android Gradle نسخه ۸.۲ توصیف می‌کند.

مرحله ۲. راه‌اندازی کیت توسعه نرم‌افزار

کتابخانه «کیت توسعه نرم‌افزار مکان‌ها، ویژه Android» ازطریق مخزن Maven متعلق به Google دردسترس است. برای افزودن کیت توسعه نرم‌افزار به برنامه‌تان، کارهای زیر را انجام دهید:

  1. در فایل settings.gradle.kts سطح بالای خود، درگاه افزایه Gradle، مخزن Google Maven، و مخزن مرکزی Maven را در بلوک pluginManagement بگنجانید. بلوک pluginManagement باید قبل‌از هر عبارت دیگری در اسکریپت ظاهر شود. 
    pluginManagement {
    repositories {
        google()
        mavenCentral()
        gradlePluginPortal()
    }
}
  2. در فایل settings.gradle.kts سطح بالای خود، مخزن Maven Google و مخزن مرکزی Maven را در بلوک dependencyResolutionManagement اضافه کنید: 
    dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
    repositories {
        google()
        mavenCentral()
    }
}

  3. در بخش dependencies فایل واحد-سطح build.gradle.kts، وابستگی به «کیت توسعه نرم‌افزار مکان‌ها، ویژه Android» اضافه کنید:

    Groovy

    dependencies {
    implementation(platform("org.jetbrains.kotlin:kotlin-bom:$kotlin_version"))
    implementation("com.google.android.libraries.places:places:3.5.0")
}

    Kotlin

              dependencies {

    // Places and Maps SDKs
    implementation("com.google.android.libraries.places:places:5.1.1")
}
  4. در فایل build.gradle.kts سطح واحد، compileSdk و minSdk را روی مقادیر زیر تنظیم کنید:

    Groovy

    android {
    compileSdk 34

    defaultConfig {
        minSdk 23
        // ...
    }
}

    Kotlin

    android {
    compileSdk = 34

    defaultConfig {
        minSdk = 23
        // ...
    }
}
  5. در بخش buildFeatures فایل build.gradle در سطح ماژول، کلاس BuildConfig را اضافه کنید که از آن برای دسترسی به مقادیر فراداده تعریف‌شده در ادامه این رویه استفاده می‌کنید:

    Groovy

    android {
  // ...
  buildFeatures {
    buildConfig true
    // ...
  }
}

    Kotlin

    android {
  // ...
  buildFeatures {
    buildConfig = true
    // ...
  }
}

مرحله ۳: کلید میانای API را به پروژه اضافه کنید

این بخش نحوه ذخیره کردن کلید میانای برنامه‌سازی کاربردی را شرح می‌دهد تا برنامه شما بتواند به‌طور ایمن به آن ارجاع دهد. نباید کلید میانای برنامه‌سازی کاربردی را در سیستم کنترل نسخه بررسی کنید، بنابراین توصیه می‌کنیم آن را در فایل secrets.properties که در دایرکتوری ریشه پروژه‌تان قرار دارد ذخیره کنید. برای اطلاعات بیشتر درباره فایل secrets.properties، به فایل‌های دارایی Gradle مراجعه کنید.

برای ساده‌سازی این کار، توصیه می‌کنیم از افزایه Secrets Gradle ویژه Android استفاده کنید.

برای نصب افزایه Secrets Gradle ویژه Android و ذخیره کلید میانای برنامه‌سازی کاربردی:

  1. در Android Studio، فایل build.gradle سطح ریشه را باز کنید و کد زیر را به عنصر dependencies در buildscript اضافه کنید.

    Groovy

    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 اضافه کنید.

    Groovy

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

    Kotlin

    plugins {
    id("com.android.application")
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}
  3. اگر از «استودیو Android» استفاده می‌کنید، پروژه‌تان را با Gradle همگام‌سازی کنید.
  4. فایل local.properties را در فهرست سطح پروژه باز کنید، و سپس کد زیر را اضافه کنید. YOUR_API_KEY را با کلید میانای API خودتان جایگزین کنید. 
    PLACES_API_KEY=YOUR_API_KEY

مرحله ۴. راه‌اندازی مشتری Places API

برای مقداردهی اولیه Places SDK for Android در یک فعالیت یا قطعه، کلید API را هنگام فراخوانی Places.initializeWithNewPlacesApiEnabled() ارسال کنید:

Kotlin

    // Define a variable to hold the Places API key.
    val apiKey = BuildConfig.PLACES_API_KEY

    // Log an error if apiKey is not set.
    if (apiKey.isEmpty() || apiKey == "DEFAULT_API_KEY") {
        Log.e("Places test", "No api key")
        finish()
        return
    }

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

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

جاوا

    // Define a variable to hold the Places API key.
    String apiKey = BuildConfig.PLACES_API_KEY;

    // Log an error if apiKey is not set.
    if (TextUtils.isEmpty(apiKey) || apiKey.equals("DEFAULT_API_KEY")) {
      Log.e("Places test", "No api key");
      finish();
      return;
    }

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

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

اکنون آماده‌اید تا استفاده از «کیت توسعه نرم‌افزار مکان‌ها ویژه Android» را شروع کنید!

مرحله ۵: راه‌اندازی دستگاه Android

برای اجرای برنامه‌ای که از Places SDK for Android استفاده می‌کند، باید آن را در دستگاه Android یا شبیه‌ساز Android که مبتنی بر Android نسخه ۶.۰ یا بالاتر است و Google APIs را دارد مستقر کنید.

  • برای استفاده از دستگاه Android، دستورالعمل‌های اجرای برنامه‌ها در دستگاه سخت‌افزاری را دنبال کنید.
  • برای استفاده از شبیه‌ساز Android، می‌توانید دستگاه مجازی ایجاد کنید و شبیه‌ساز را بااستفاده از مدیر دستگاه مجازی Android (AVD) که همراه با Android Studio ارائه می‌شود نصب کنید.

مراحل بعدی

پس‌از پیکربندی پروژه، می‌توانید برنامه‌های نمونه را کاوش کنید.