הגדרת Maps SDK ל-Android

במאמר הזה מפורטים השלבים שצריך לבצע כדי להתחיל להשתמש ב-SDK של מפות ל-Android.

דרישות מוקדמות

כאן נסביר איך מגדירים חשבון Google Cloud ופרויקט בענן ב-Google Cloud עם חיוב מופעל. חשוב גם להכיר את אופן החיוב על השימוש ב-SDK של מפות ל-Android.

  1. בדיקת החיוב והעלות של השימוש ב-SDK של מפות ל-Android.

  2. מוודאים שיש לכם חשבון Google Cloud.

    נכנסים למסוף Google Cloud

  3. מוודאים שיש לכם פרויקט ב-Google Cloud שהחיוב מופעל בו.

    כניסה לדף Billing
    1. בוחרים את הפרויקט כדי לפתוח את הדף Billing.

    2. בדף Billing:

      • אם החיוב כבר מופעל בפרויקט שנבחר ויש לכם רק חשבון לחיוב אחד, ייפתח הדף Billing.
      • אם יש לכם כמה חשבונות לחיוב, לוחצים על Go to linked billing account כדי לראות את הפרטים של החשבון לחיוב שמשויך לפרויקט.
      • אם קיים חשבון לחיוב אבל הוא לא משויך לפרויקט, תתבקשו לקשר חשבון לחיוב לפרויקט.
      • אם אין חשבון לחיוב או שרוצים ליצור חשבון חדש, בוחרים באפשרות Manage Billing Accounts כדי ליצור חשבון חדש לחיוב. למידע נוסף, קראו את המאמר איך יוצרים חשבון חדש לחיוב ב-Cloud בשירות עצמי.

הפעלת ה-SDK

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

כדי להפעיל את ה-SDK:

המסוף

  1. פותחים את דף המוצר במסוף Google Cloud:

    הפעלת SDK של מפות ל-Android

  2. לוחצים על הכפתור הפעלה.

gcloud

gcloud services enable \
    --project "PROJECT" \
    "maps-android-backend.googleapis.com"

מידע נוסף על Google Cloud SDK, התקנת Cloud SDK והפקודות הבאות:

הגדרת מפתח API

כדי להגן על המוצרים של Google Maps Platform מפני שימוש לא מורשה, צריך לכלול מפתח API בקריאות ל-API.

איך מקבלים מפתח API לשימוש ב-SDK של מפות ל-Android

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

המסוף

  1. נכנסים לדף Google Maps Platform > Keys & Credentials.

    כניסה לדף Keys & Credentials

  2. אם מתבקשים, בוחרים את הפרויקט.

  3. מבצעים אחת מהפעולות האלה:

    • יצירת מפתח חדש:

      1. לוחצים על Create credentials > מפתח API.
      2. בחלונית יצירת מפתח API, פותחים את הרשימה בחירת הגבלות API.
      3. מבטלים את הסימון של כל ממשקי ה-API שהמפתח הזה לא צריך, ומוודאים שהאפשרות Maps SDK for Android נשארת מסומנת.
      4. לוחצים על יצירה. בחלונית מוצג מפתח ה-API החדש.

    • שימוש במפתח קיים:

      1. לוחצים על שם המפתח.
      2. ברשימה Select API restrictions, בוחרים באפשרות SDK של מפות ל-Android.
      3. לוחצים על שמירה.

    בחירת API כאן לא מפעילה אותו. מוודאים ש-Maps SDK for Android מופעל בדף ספריית ה-API שלו.

  4. כדי לראות את מחרוזת המפתח מאוחר יותר, עוברים לדף Keys & Credentials ולוחצים על Show key ליד המפתח.

אם המסוף נראה שונה מהשלבים האלה, עיינו במאמרים יצירת מפתח API והוספת הגבלות על API במסמכי התיעוד של Google Cloud.

gcloud

בפקודות הבאות, מחליפים את PROJECT_ID במזהה הפרויקט.

  • יצירת מפתח חדש: מריצים את הפקודה הבאה ומחליפים את DISPLAY_NAME בשם של המפתח. 

    gcloud services api-keys create \
    --project="PROJECT_ID" \
    --display-name="DISPLAY_NAME" \
    --api-target=service=maps-android-backend.googleapis.com

    מידע נוסף על Google Cloud SDK, התקנת Cloud SDK והפקודות הבאות:

  • שימוש במפתח קיים: מריצים את הפקודה הבאה ומחליפים את KEY_ID במזהה המפתח. הדגל --append שומר על ממשקי ה-API שהמפתח כבר מאפשר. בלעדיו, הפקודה מחליפה אותם.

    gcloud services api-keys update KEY_ID \
    --project="PROJECT_ID" \
    --append \
    --api-target=service=maps-android-backend.googleapis.com

    מידע נוסף על Google Cloud SDK, התקנת Cloud SDK והפקודות הבאות:

    מזהה המפתח הוא לא מחרוזת המפתח או השם המוצג. כדי למצוא אותו, מריצים את הפקודה gcloud services api-keys list --project="PROJECT_ID". המזהה הוא החלק האחרון בשדה name: projects/PROJECT_NUMBER/locations/global/keys/KEY_ID.

כדי לראות את מחרוזת המפתח, מריצים את הפקודה gcloud services api-keys get-key-string KEY_ID --project="PROJECT_ID".

החלת הגבלות על מפתחות API

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

  • הגבלות על ממשקי API מציינות לאילו ערכות SDK וממשקי API אפשר לקרוא באמצעות מפתח ה-API. כשיוצרים מפתח במסוף וב-CLI של gcloud, צריך להגדיר לפחות הגבלה אחת ל-API.
  • הגבלות על אפליקציות מציינות אילו כתובות IP, אפליקציות ואתרים יכולים להשתמש במפתח API.

מידע נוסף על הגבלות זמין במאמר הגבלת מפתחות API.

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

אחרי שהפעלתם את ה-SDK של מפות ל-Android והגדרתם מפתח API, אתם יכולים לקרוא את המאמר הגדרת פרויקט ב-Android Studio כדי ללמוד איך להגדיר את Android Studio ואיך להעביר את מפתח ה-API לאפליקציה.