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

כדי לשלוח בקשה ל-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 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