پروژه کنسول Google Cloud را پیکربندی کنید

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

  1. راه‌اندازی پروژه توسعه.
  2. کیت توسعه نرم‌افزار مصرف‌کننده را به برنامه‌تان اضافه کنید.
  3. کلید میانای برنامه‌سازی کاربردی را به برنامه‌تان اضافه کنید.
  4. ارجاع‌های لازم را در برنامه‌تان بگنجانید.

برای جزئیات بیشتر درباره هر مرحله، بخش‌های زیر را ببینید.

راه‌اندازی پروژه توسعه

اگر پروژه توسعه کنسول Google Cloud و کلید میانای برنامه‌سازی کاربردی برای پروژه جابه‌جایی‌تان ندارید، باید یکی راه‌اندازی کنید. برای جزئیات، ایجاد پروژه را در راهنمای Fleet Engine ببینید.

هنگام انتخاب پروژه توسعه برای Consumer SDK، همان پروژه کنسول Google Cloud و کلید API را که برای Fleet Engine استفاده می‌کنید، انتخاب کنید.

افزودن Consumer SDK به برنامه

«کیت توسعه نرم‌افزار مصرف‌کننده» از مخزن Google Maven دردسترس است. این مخزن شامل فایل‌های «مدل شیء پروژه» (‎.pom) کیت توسعه نرم‌افزار و Javadocs است. برای افزودن «کیت توسعه نرم‌افزار مصرف‌کننده» به برنامه‌تان، وابستگی‌های «کیت توسعه نرم‌افزار مصرف‌کننده» و «کیت توسعه نرم‌افزار Maps» را به پیکربندی Gradle یا Maven اضافه کنید.

در مثال‌های زیر، VERSION_NUMBER را با نسخه موردنیاز «کیت توسعه نرم‌افزار مصرف‌کننده» جایگزین کنید:

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 را اضافه کنید. باید از کلید میانای API پروژه که هنگام راه‌اندازی پروژه توسعه‌تان دریافت کردید استفاده کنید. برای جزئیات بیشتر، به راه‌اندازی پروژه توسعه در مرحله ۳ این راهنما مراجعه کنید.

این بخش نحوه ذخیره کردن کلید میانای برنامه‌سازی کاربردی را شرح می‌دهد تا برنامه‌تان بتواند به‌طور ایمن‌تری به آن ارجاع دهد. برای اطلاعات بیشتر درباره روال‌های مطلوب امنیتی کلید میانای برنامه‌سازی کاربردی، مقاله Google Maps Platform درباره روال‌های مطلوب امنیتی میانای برنامه‌سازی کاربردی را ببینید.

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

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

  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» استفاده می‌کنید، پروژه‌تان را با 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>

ارجاع‌های لازم را در برنامه‌تان بگنجانید

اگر از «کیت توسعه نرم‌افزار مصرف‌کننده» در برنامه‌تان استفاده می‌کنید، باید نوشتار انتساب و پروانه‌های متن‌باز را به‌عنوان بخشی از بخش ابلاغیه‌های حقوقی برنامه‌تان اضافه کنید. بهتر است که ارجاع‌ها را به‌عنوان یک گزینه منو مستقل یا به‌عنوان بخشی از گزینه منو درباره اضافه کنید.

می‌توانید اطلاعات پروانه را در فایل «third_party_licenses.txt» در فایل AAR غیربایگانی‌شده پیدا کنید.

برای اطلاع از نحوه گنجاندن اعلامیه‌های متن‌باز، به https://developers.google.com/android/guides/opensource مراجعه کنید.

قدم بعدی چیست

دریافت کدهای اصالت‌سنجی