פרמטרים נדרשים של בקשה

כדי לשלוח בקשה אל Maps Datasets API, צריך לכלול:

  • המספר או המזהה של הפרויקט ב-Google Cloud בכותרת X-Goog-User-Project של הבקשה. הערך הזה קובע את הפרויקט שמשמש לחישובים של מכסות השימוש והחיוב.

  • אסימון OAuth בכותרת Authorization של הבקשה. מידע נוסף על השימוש ב-OAuth עם Maps Datasets API זמין במאמר שימוש ב-OAuth.

  • מספר או מזהה של פרויקט ב-Google Cloud בכתובת ה-URL של הבקשה. הערך הזה מציין את הפרויקט שמכיל את מערך הנתונים. הפרויקט הזה בדרך כלל זהה לפרויקט שצוין בכותרת X-Goog-User-Project, אבל הוא לא חייב להיות זהה.

  • מזהה מערך הנתונים בכתובת ה-URL של הבקשה. בכל פעם שמבצעים פעולה במערך נתונים ספציפי, מעבירים את המזהה של מערך הנתונים כחלק מכתובת ה-URL של הבקשה.

לדוגמה, כדי למחוק מערך נתונים:

curl -X DELETE \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/DATASET_ID

קבלת מספר הפרויקט

כדי לקבל את PROJECT_NUMBER_OR_ID של פרויקט Google Cloud:

  1. נכנסים לדף Overview של הפרויקט במסוף Cloud.

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

  3. Project number ו-Project ID מופיעים באזור Project info במסך הסקירה הכללית.

קבלת אסימון OAuth

כדי לבצע אימות, בקשת ה-API צריכה להכיל אסימון OAuth בכותרת Authorization. מידע נוסף זמין במאמר שימוש ב-OAuth.

לדוגמה, כדי ליצור את האסימון, משתמשים בפקודה gcloud הבאה:

gcloud auth application-default print-access-token

אפשר לכלול את הפקודה gcloud ישירות בכותרת Authorization בפקודת cURL כדי ליצור אסימון חדש בכל בקשה, כמו בדוגמה שלמעלה.

לחלופין, אפשר להגדיר משתנה סביבה שמכיל את האסימון ואז להעביר את משתנה הסביבה כחלק מהבקשה:

export TOKEN=$(gcloud auth application-default print-access-token)
curl -X DELETE \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H "Authorization: Bearer $TOKEN" \
https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/DATASET_ID