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

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

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

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

شما می‌توانید داده‌های جدید را به مجموعه داده آپلود کنید تا یک نسخه جدید از مجموعه داده ایجاد شود:

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

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

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

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

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

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

این درخواست، اطلاعاتی در مورد آخرین نسخه از تمام مجموعه داده‌ها، صرف نظر از اینکه آیا نسخه، نسخه فعال است یا خیر، برمی‌گرداند. اگر فقط می‌خواهید نسخه فعال هر مجموعه داده را فهرست کنید، پارامتر query 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 به نقطه پایانی get dataset ارسال کنید که شامل شناسه مجموعه داده نیز باشد:

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