پارامترهای درخواستی مورد نیاز

برای ارائه هر گونه درخواست به Maps Datasets API، باید موارد زیر را وارد کنید:

• شماره یا شناسه پروژه Google Cloud شما در هدر X-Goog-User-Project درخواست. این مقدار پروژه مورد استفاده برای صورتحساب و محاسبات سهمیه استفاده را تعیین می کند.

  توجه: اگر از یک حساب کاربری برای احراز هویت استفاده می کنید، می توانید هدر X-Goog-User-Project را حذف کنید. برای اطلاعات بیشتر در مورد حساب‌های سرویس، احراز هویت در Google را ببینید.

• یک نشانه 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. به صفحه نمای کلی پروژه در Cloud Console بروید.

2. اگر از شما خواسته شد، پروژه خود را انتخاب کنید.

3. شماره پروژه و شناسه پروژه در قسمت اطلاعات پروژه در صفحه نمای کلی ظاهر می شود.

یک نشانه OAuth دریافت کنید

توجه: رویه زیر برای تولید توکن 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