دریافت مجموعه داده

پس‌از ایجاد مجموعه داده و بارگذاری داده در آن، می‌توانید از درخواست‌های HTTP GET برای دسترسی به مجموعه داده استفاده کنید. این صفحه نحوه فهرست کردن همه مجموعه‌های داده، نحوه دریافت اطلاعات درباره مجموعه داده‌ای خاص، و نحوه بارگیری داده‌ها از مجموعه داده را شرح می‌دهد.

درباره نسخه‌های مجموعه داده

پس‌از بارگذاری موفقیت‌آمیز داده‌ها، وضعیت مجموعه داده روی STATE_COMPLETED تنظیم می‌شود و آن مجموعه داده به نسخه فعال تبدیل می‌شود. یعنی مجموعه داده برای استفاده در برنامه‌تان آماده است. برای تعیین state مجموعه داده، می‌توانید همه مجموعه‌های داده را فهرست کنید یا مجموعه داده خاصی را دریافت کنید.

می‌توانید داده‌های جدیدی را در مجموعه داده بارگذاری کنید تا نسخه جدیدی از مجموعه داده ایجاد شود:

• اگر داده‌های جدید با موفقیت بارگذاری شود، نسخه جدید به نسخه «فعال» تبدیل می‌شود و نسخه‌ای است که برنامه‌تان از آن استفاده می‌کند.

• اگر خطایی در بارگذاری وجود داشته باشد، نسخه مجموعه داده موفق قبلی به‌عنوان نسخه «فعال» باقی می‌ماند و نسخه‌ای است که توسط برنامه شما استفاده می‌شود.

برای کسب اطلاعات بیشتر درباره ایجاد نسخه جدیدی از مجموعه داده، به بارگذاری داده‌های جدید در مجموعه داده مراجعه کنید.

فهرست کردن همه مجموعه‌های داده

با ارسال درخواست HTTP GET به نقطه پایان فهرست کردن مجموعه‌های داده، همه مجموعه‌های داده را فهرست کنید:

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets

این درخواست اطلاعات مربوط به جدیدترین نسخه همه مجموعه‌داده‌ها را برمی‌گرداند، صرف‌نظر از اینکه نسخه فعال باشد یا نه. اگر فقط می‌خواهید نسخه فعال هر مجموعه داده را فهرست کنید، پارامتر پُرسمان tag=active را به درخواست اضافه کنید:

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets?tag=active

برای مثال، این فراخوانی اطلاعات مربوط به جدیدترین نسخه همه مجموعه‌داده‌ها را برمی‌گرداند:

curl -X GET \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H 'Authorization: Bearer $TOKEN' \
"https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets"

این فراخوانی پاسخی را در فرم برمی‌گرداند:

{
  "datasets": [
    {
      "name": "projects/PROJECT_NUMBER_OR_ID/datasets/f57074a0-a8b6-403e-9df1-e8a9e4f9fc46",
      "displayName": "My Test Dataset",
      "versionId": "5fb34e-1405-4ecd-8f81-31f1c07",
      "usage": [
        "USAGE_DATA_DRIVEN_STYLING"
      ],
      "gcsSource": {
        "inputUri": "gs://mybucket/my.csv",
        "fileFormat": "FILE_FORMAT_CSV"
      },
      "createTime": "2023-03-24T14:47:37.308977Z",
      "updateTime": "2023-03-24T14:48:05.053114Z",
      "versionCreateTime": "2023-03-24T14:48:05.053114Z",
      "status": {
        "state": "STATE_COMPLETED"
      }
    },
    {
      "name": "projects/PROJECT_NUMBER_OR_ID/datasets/2c8ae479-96704-89c6435ca959",
      "displayName": "My Other Test Dataset",
      "versionId": "0d2e3-b9da-47cc-819f-7ac67562",
      "usage": [
        "USAGE_DATA_DRIVEN_STYLING"
      ],
      "localFileSource": {
        "fileFormat": "FILE_FORMAT_CSV"
      },
      "createTime": "2023-03-24T14:41:52.579755Z",
      "updateTime": "2023-03-24T14:42:56.784122Z",
      "versionCreateTime": "2023-03-24T14:42:56.784122Z",
      "status": {
        "state": "STATE_COMPLETED"
      }
    }
  ]
}

دریافت اطلاعات درباره مجموعه داده

برای دریافت اطلاعات درباره مجموعه داده‌ای خاص، درخواست HTTP GET را به نقطه پایانی دریافت مجموعه داده ارسال کنید که شامل شناسه مجموعه داده نیز باشد:

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/DATASET_ID

این درخواست اطلاعاتی درباره جدیدترین نسخه مجموعه داده برمی‌گرداند، صرف‌نظر از اینکه نسخه فعال باشد یا نه. اگر اطلاعاتی درباره نسخه فعال مجموعه داده می‌خواهید، برچسب @active را به درخواست اضافه کنید:

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/DATASET_ID@active

برای مثال:

curl -X GET \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H 'Authorization: Bearer $TOKEN' \
"https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/f57074a0-a8b6-403e-9df1-e8a9e4f9fc46@active"

این درخواست پاسخی را در فرم برمی‌گرداند:

{
  "name": "projects/PROJECT_NUMBER_OR_ID/datasets/f57074a0-a8b6-403e-9df1-e8a9e4f9fc46",
  "displayName": "My Test Dataset",
  "versionId": "5fb34e-1405-4ecd-8f81-31f1c07",
  "usage": [
    "USAGE_DATA_DRIVEN_STYLING"
  ],
  "gcsSource": {
    "inputUri": "gs://mybucket/my.csv",
    "fileFormat": "FILE_FORMAT_CSV"
  },
  "createTime": "2023-03-24T14:47:37.308977Z",
  "updateTime": "2023-03-24T14:48:05.053114Z",
  "versionCreateTime": "2023-03-24T14:48:05.053114Z",
  "status": {
    "state": "STATE_COMPLETED"
  }
}

بارگیری مجموعه داده

برای بارگیری داده‌ها از جدیدترین نسخه مجموعه‌داده، درخواست HTTP GET به نقطه پایانی بارگیری مجموعه‌داده ارسال کنید که شامل شناسه مجموعه‌داده نیز باشد:

توجه: ممکن است جدیدترین نسخه، نسخه فعال مجموعه داده نباشد.

https://mapsplatformdatasets.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID/datasets/DATASET_ID:download?alt=media

برای مثال:

curl -X GET -L \
-H 'X-Goog-User-Project: PROJECT_NUMBER_OR_ID' \
-H 'Authorization: Bearer $TOKEN' \
--output LOCAL_LOCATION_TO_OUTPUT \
"https://mapsplatformdatasets.googleapis.com/download/v1/projects/PROJECT_NUMBER_OR_ID/datasets/f57074a0-a8b6-403e-9df1-e8a9e4f9fc46:download?alt=media"

در این مثال، از گزینه cURL --output برای مشخص کردن نام فایلی که داده‌های بارگیری‌شده را نگه می‌دارد استفاده می‌کنید. برای مثال، پرچم --output زیر مشخص می‌کند که مجموعه داده در فایلی با نام myjson.json در همان دایرکتوری مورداستفاده برای اجرای فرمان cURL بارگیری شود:

--output myjson.json

یا از پرچم زیر برای بارگیری داده‌ها در myjson.json در فهرست راهنمای /tmp استفاده کنید:

--output /tmp/myjson.json