Thiết lập

Trang này mô tả những việc bạn cần làm để thiết lập và bắt đầu xây dựng bằng Maps 3D SDK cho Android. Quy trình thiết lập bao gồm việc định cấu hình một dự án Google Cloud và API để sử dụng với SDK, sau đó thiết lập một dự án Android Studio. Hoàn tất các bước sau trước khi thêm bản đồ 3D đầu tiên vào ứng dụng của bạn.

Thiết lập dự án trên Google Cloud và khoá API

Trước khi có thể bắt đầu tạo bằng Maps 3D SDK cho Android, bạn cần thiết lập một dự án Google Cloud và khoá API để sử dụng với Maps 3D SDK cho Android bằng cách hoàn tất các bước sau:

Bước 1

Giao diện dòng lệnh

  1. Trong Google Cloud Console, trên trang chọn dự án, hãy nhấp vào Tạo dự án để bắt đầu tạo một dự án Cloud mới.

    Chuyển đến trang chọn dự án

  2. Đảm bảo bạn đã bật tính năng thanh toán cho dự án trên Cloud. Xác nhận rằng bạn đã bật tính năng thanh toán cho dự án của mình.

    Google Cloud cung cấp bản dùng thử không tính phí. Thời gian dùng thử sẽ kết thúc sau 90 ngày hoặc sau khi tài khoản tích luỹ được khoản phí trị giá 3.000.000 VND, tuỳ theo điều kiện nào đến trước. Huỷ bất cứ lúc nào. Để biết thêm thông tin, hãy xem bài viết Khoản tín dụng trong tài khoản thanh toánThanh toán.

SDK đám mây

gcloud projects create "PROJECT"

Đọc thêm về Google Cloud SDK, quy trình cài đặt Cloud SDK và các lệnh sau:

Bước 2

Để sử dụng Nền tảng Google Maps, bạn phải bật các API hoặc SDK mà bạn dự định sử dụng cho dự án của mình.

Xin lưu ý rằng một số hoạt động tích hợp yêu cầu bạn bật nhiều API/SDK. Nếu không chắc nên bật API hoặc SDK nào, hãy thử dùng API Picker hoặc tham khảo tài liệu về API/SDK mà bạn muốn dùng.

Cách bật một hoặc nhiều API hoặc SDK:

Giao diện dòng lệnh

  1. Xem các API và SDK của Google Maps Platform mà bạn có thể bật bằng cách chuyển đến trang Thư viện API Maps trong Cloud Console:

    Chuyển đến trang Thư viện Maps API

  2. Nhấp vào API hoặc SDK bạn muốn bật.
    • Nếu nút này có nội dung là BẬT, hãy nhấp vào nút này để bật API hoặc SDK.
    • Nếu nút này có nội dung QUẢN LÝ, tức là API hoặc SDK đã được bật và bạn không cần làm gì thêm.
    • Khi bạn nhấp vào một trong hai nút này, trang tổng quan cho API hoặc SDK sẽ xuất hiện. (Nhấp vào nút TẮT để xoá API hoặc SDK khỏi dự án này.)

SDK đám mây

Lệnh sau đây bật tất cả các API Maps, Tuyến đường và Địa điểm:

gcloud services enable \
    --project "PROJECT" \
    "addressvalidation.googleapis.com" \
    "areainsights.googleapis.com" \
    "tile.googleapis.com" \
    "aerialview.googleapis.com" \
    "elevation-backend.googleapis.com" \
    "routes.googleapis.com" \
    "geocoding-backend.googleapis.com" \
    "geolocation.googleapis.com" \
    "maps-android-backend.googleapis.com" \
    "maps-backend.googleapis.com" \
    "maps-embed-backend.googleapis.com" \
    "maps-ios-backend.googleapis.com" \
    "mapsplatformdatasets.googleapis.com" \
    "places-backend.googleapis.com" \
    "roads.googleapis.com" \
    "routeoptimization.googleapis.com" \
    "static-maps-backend.googleapis.com" \
    "street-view-image-backend.googleapis.com" \
    "timezone-backend.googleapis.com"

Đọc thêm về Google Cloud SDK, quy trình cài đặt Cloud SDK và các lệnh sau:

Dùng lệnh này để bật Environment API:

gcloud services enable \
    --project "PROJECT" \
    "airquality.googleapis.com" \
    "solar.googleapis.com" \
    "pollen.googleapis.com" \
    "weather.googleapis.com"

Bước 3

Bước này chỉ hướng dẫn quy trình tạo Khoá API. Nếu sử dụng Khoá API trong quá trình phát hành chính thức, bạn nên hạn chế Khoá API của mình. Bạn có thể tìm thêm thông tin trên trang Sử dụng khoá API dành riêng cho sản phẩm.

Khoá API là một giá trị nhận dạng duy nhất xác thực các yêu cầu liên kết với dự án của bạn cho mục đích sử dụng và thanh toán. Bạn phải có ít nhất một khoá API được liên kết với dự án của mình.

Cách tạo khoá API:

Giao diện dòng lệnh

  1. Chuyển đến trang Nền tảng Google Maps > Thông tin đăng nhập.

    Chuyển đến trang Thông tin đăng nhập

  2. Trên trang Thông tin xác thực, hãy nhấp vào Tạo thông tin xác thực > Khoá API.
    Hộp thoại Khoá API đã tạo sẽ hiển thị khoá API mới tạo.
  3. Nhấp vào Đóng.
    Khoá API mới sẽ xuất hiện trên trang Thông tin xác thực trong phần Khoá API.
    (Hãy nhớ hạn chế API trước khi sử dụng khoá này trong quá trình phát hành công khai.)

SDK đám mây

gcloud services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

Đọc thêm về Google Cloud SDK, quy trình cài đặt Cloud SDK và các lệnh sau:

Để bật SDK này, hãy xem trang SDK Maps 3D dành cho Android trong Google Cloud Console. Để biết thêm thông tin về cách hoàn tất các bước này, hãy xem bài viết Bắt đầu sử dụng Nền tảng Google Maps.

Thiết lập một dự án Android Studio

Phần này giải thích cách tạo và định cấu hình một dự án Android Studio để sử dụng với Maps 3D SDK cho Android.

Phần 1: Thiết lập dự án và cấu hình Gradle

  1. Tạo một dự án Android Studio mới bằng mẫu Empty Views Activity (Hoạt động khung hiển thị trống).

  2. Nếu bạn đang sử dụng Git để kiểm soát nguồn, hãy sửa đổi tệp .gitignore của dự án để ngăn tệp bí mật của bạn được cam kết kiểm soát phiên bản:

    • Trong thư mục gốc của dự án, hãy mở tệp .gitignore.
    • Hãy thêm dòng lệnh sau đây:
    secrets.properties
    
  3. Cập nhật tệp build.gradle.kts cấp dự án:

    • Trong thư mục gốc của dự án, hãy mở tệp build.gradle.kts.
    • Trong khối plugins, hãy thêm trình bổ trợ Secrets Gradle:
    plugins {
      alias(libs.plugins.android.application) apply false
      alias(libs.plugins.kotlin.android) apply false
      alias(libs.plugins.secrets.gradle.plugin) apply false // Add this line
    }
    
  4. Cập nhật tệp gradle/libs.versions.toml: – Mở tệp gradle/libs.versions.toml. Tệp này thường nằm trong thư mục gradle trong thư mục gốc của dự án. – Trong phần phiên bản, hãy thêm các phiên bản cho SDK và trình bổ trợ Secrets Gradle:

    maps3dSdk = "0.0.1" # Update this value to match the SDK version to include
    secretsGradlePlugin = "2.0.1"
    
    -   In the library section, add the SDK library:
    
    play-services-maps3d = { module = "com.google.android.gms:play-services-maps3d", version.ref = "maps3dSdk" }
    
    -   In the plugin section, add the Secrets Gradle plugin:
    
    secrets-gradle-plugin = { id = "com.google.android.libraries.mapsplatform.secrets-gradle-plugin", version.ref = "secretsGradlePlugin" }
    
  5. Cập nhật tệp app/build.gradle.kts ở cấp mô-đun: – Mở tệp build.gradle.kts ở cấp mô-đun. Tệp này thường nằm trong thư mục app. – Ở đầu tệp, hãy thêm trình bổ trợ Secrets Gradle vào khối plugins:

    plugins {
      alias(libs.plugins.android.application)
      alias(libs.plugins.kotlin.android)
      alias(libs.plugins.secrets.gradle.plugin) // Add this line
    }
    
    -   In the `dependencies` block, add the SDK:
    
    dependencies {
      // ... other dependencies
      implementation(libs.play.services.maps3d) // Add this line
    }
    
    -   At the end of the file, outside of the `android` and `dependencies`
        blocks, add the secrets configuration:
    
    secrets {
      // Optionally specify a different filename 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"
    }
    

Phần 2: Thêm khoá API vào dự án

  1. Tạo tệp secrets.properties:

    • Trong thư mục gốc của mô-đun ứng dụng (thường là thư mục app), hãy tạo một tệp mới có tên là secrets.properties.
    • Thêm khoá API vào tệp:
    MAPS3D_API_KEY=YOUR_API_KEY_HERE
    ``` Note: Make sure you
        replace `YOUR_API_KEY_HERE` with the API key that you configured for use
    with the Maps 3D SDK for Android.
    
  2. Tạo tệp local.defaults.properties: – Trong thư mục gốc của mô-đun ứng dụng, hãy tạo một tệp mới có tên là secrets.properties. – Thêm khoá API mặc định hoặc khoá API giữ chỗ vào tệp. Bạn có thể kiểm tra tệp này trong phần kiểm soát phiên bản:

    MAPS3D_API_KEY=DEFAULT_API_KEY_OR_PLACEHOLDER
    

Phần 3: Cập nhật tệp AndroidManifest.xml

  1. Mở tệp app/src/main/AndroidManifest.xml.

  2. Bên trong thẻ <application>, trước thẻ <activity>, hãy thêm phần tử <meta-data> sau đây để khai báo khoá API của bạn:

    <application
      ...>
    
      <meta-data
          android:name="com.google.android.geo.maps3d.API_KEY"
          android:value="${MAPS3D_API_KEY}" />
    
      <activity
          ...>
      </activity>
    </application>
    

    Trong quá trình tạo bản dựng, Secrets Gradle Plugin sẽ thay thế trình giữ chỗ ${MAPS3D_API_KEY} bằng khoá trong tệp secrets.properties của bạn.

Các bước tiếp theo

Giờ đây, bạn đã thiết lập một dự án Google Cloud, khoá API và một dự án Android Studio để sử dụng với Maps 3D SDK cho Android, bạn có thể Thêm bản đồ 3D vào ứng dụng của mình.