Package google.maps.mapsplatformdatasets.v1

فهرست مطالب

MapsPlatformDatasets

تعریف سرویس برای Maps Platform Datasets API.

CreateDataset

rpc CreateDataset( CreateDatasetRequest ) returns ( Dataset )

یک مجموعه داده جدید برای پروژه مشخص شده ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع parent نیاز دارد:

  • mapsplatformdatasets.datasets.create

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

DeleteDataset

rpc DeleteDataset( DeleteDatasetRequest ) returns ( Empty )

مجموعه داده مشخص شده را حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع name نیاز دارد:

  • mapsplatformdatasets.datasets.delete

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

مجموعه داده را دانلود کنید

rpc DownloadDataset( DownloadDatasetRequest ) returns ( DownloadDatasetResponse )

یک مجموعه داده را دانلود می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع name نیاز دارد:

  • mapsplatformdatasets.datasets.export

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

FetchDatasetErrors

rpc FetchDatasetErrors( FetchDatasetErrorsRequest ) returns ( FetchDatasetErrorsResponse )

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

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع dataset نیاز دارد:

  • mapsplatformdatasets.datasets.get

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

GetDataset

rpc GetDataset( GetDatasetRequest ) returns ( Dataset )

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

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع name نیاز دارد:

  • mapsplatformdatasets.datasets.get

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

ImportDataset

rpc ImportDataset( ImportDatasetRequest ) returns ( ImportDatasetResponse )

نسخه جدیدی از داده ها را برای مجموعه داده وارد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع name نیاز دارد:

  • mapsplatformdatasets.datasets.import

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

ListDatasets

rpc ListDatasets( ListDatasetsRequest ) returns ( ListDatasetsResponse )

تمام مجموعه داده ها را برای پروژه مشخص شده فهرست می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع parent نیاز دارد:

  • mapsplatformdatasets.datasets.list

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

UpdateDatasetMetadata

rpc UpdateDatasetMetadata( UpdateDatasetMetadataRequest ) returns ( Dataset )

فراداده را برای مجموعه داده به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
مجوزهای IAM

به مجوز IAM زیر در منبع name نیاز دارد:

  • mapsplatformdatasets.datasets.update

برای اطلاعات بیشتر، به مستندات IAM مراجعه کنید.

CreateDatasetRequest

درخواست ایجاد مجموعه داده نقشه ها.

زمینه های
parent

string

ضروری. پروژه والد که مجموعه داده را در اختیار خواهد داشت. قالب: پروژه ها/{پروژه}

dataset

Dataset

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

مجموعه داده

نمایشی از یک منبع مجموعه داده.

زمینه های
name

string

نام منبع. قالب: projects/{project}/datasets/{dataset_id}

display_name

string

نام قابل خواندن توسط انسان، نشان داده شده در رابط کاربری کنسول.

باید در یک پروژه منحصر به فرد باشد.

description

string

شرح این مجموعه داده

version_id

string

شناسه نسخه مجموعه داده.

usage[]

Usage

مورد استفاده مشخص شده برای این مجموعه داده.

status

Status

فقط خروجی وضعیت این نسخه مجموعه داده.

create_time

Timestamp

فقط خروجی زمانی که مجموعه داده برای اولین بار ایجاد شد.

update_time

Timestamp

فقط خروجی زمانی که ابرداده مجموعه داده آخرین بار به روز شد.

version_create_time

Timestamp

فقط خروجی زمان ایجاد این نسخه

version_description

string

فقط خروجی توضیحات این نسخه از مجموعه داده. هنگام وارد کردن داده ها به مجموعه داده ارائه می شود.

data_source فیلد اتحادیه . جزئیات مربوط به منبع داده برای مجموعه داده. data_source تنها می تواند یکی از موارد زیر باشد:
local_file_source

LocalFileSource

یک منبع فایل محلی برای مجموعه داده برای یک بارگذاری.

gcs_source

GcsSource

منبع فایل Google Cloud Storage برای مجموعه داده برای یک بار آپلود.

DeleteDatasetRequest

درخواست حذف مجموعه داده

زمینه های
name

string

ضروری. نام مجموعه داده برای حذف. قالب: projects/{project}/datasets/{dataset_id}

دانلودDatasetRequest

درخواست دانلود مجموعه داده.

زمینه های
name

string

نام منبع مجموعه داده برای واکشی. قالب: projects/{project}/datasets/{dataset_id}

DownloadDatasetResponse

شی پاسخ از DownloadDataset.

FetchDatasetErrorsRequest

درخواست فهرست کردن خطاهای دقیق متعلق به یک مجموعه داده.

زمینه های
dataset

string

ضروری. نام مجموعه داده برای فهرست کردن تمام خطاها. قالب: projects/{project}/datasets/{dataset_id}

page_size

int32

حداکثر تعداد خطا برای بازگشت در هر صفحه.

حداکثر مقدار 500 است. مقادیر بالای 500 به 500 محدود می شود.

اگر نامشخص باشد، حداکثر 50 خطا برگردانده می شود.

page_token

string

نشانه صفحه، دریافت شده از تماس قبلی ListDatasetErrors. این را برای بازیابی صفحه بعدی ارائه کنید.

FetchDatasetErrorsResponse

شی پاسخ FetchDatasetErrors.

زمینه های
next_page_token

string

نشانه ای که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود.

اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد.

errors[]

Status

خطاهای مرتبط با یک مجموعه داده

فرمت فایل

فرمت فایل در حال آپلود

Enums
FILE_FORMAT_UNSPECIFIED فرمت فایل نامشخص
FILE_FORMAT_GEOJSON فایل GeoJson.
FILE_FORMAT_KML فایل KML.
FILE_FORMAT_CSV فایل CSV.

منبع Gcs

جزئیات مربوط به منبع داده زمانی که در Google Cloud Storage باشد.

زمینه های
input_uri

string

URI داده منبع. به عنوان مثال، gs://my_bucket/my_object .

file_format

FileFormat

قالب فایل شی Google Cloud Storage. این عمدتا برای اعتبار سنجی استفاده می شود.

GetDatasetRequest

درخواست دریافت مجموعه داده مشخص شده

زمینه های
name

string

ضروری. نام منبع. قالب: projects/{project}/datasets/{dataset_id}

همچنین می‌توانید برخی از نسخه‌های ویژه را با افزودن «@» و یک برچسب دریافت کنید. قالب: پروژه‌ها/{project}/datasets/{dataset_id}@{tag}

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

ImportDatasetRequest

درخواست وارد کردن نسخه جدیدی از مجموعه داده.

زمینه های
name

string

ضروری. نام منبع. قالب: projects/{project}/datasets/{dataset_id}

version_description

string

شرح داده های جدید وارد شده

data_source میدان اتحادیه . جزئیات مربوط به منبع داده برای مجموعه داده. data_source تنها می تواند یکی از موارد زیر باشد:
local_file_source

LocalFileSource

یک منبع فایل محلی برای مجموعه داده برای یک بار وارد کردن.

gcs_source

GcsSource

منبع فایل Google Cloud Storage برای مجموعه داده برای یک بار وارد کردن.

ImportDatasetResponse

شی پاسخ ImportDataset.

زمینه های
name

string

ضروری. نام منبع نسخه مجموعه داده جدید ایجاد شده. قالب: پروژه‌ها/{project}/datasets/{dataset_id}@{version_id}

ListDatasetsRequest

درخواست فهرست کردن مجموعه داده‌های پروژه.

زمینه های
parent

string

ضروری. نام پروژه برای فهرست کردن همه مجموعه داده ها. قالب: پروژه ها/{پروژه}

page_size

int32

حداکثر تعداد مجموعه داده برای بازگشت در هر صفحه.

اگر نامشخص (یا صفر) باشد، تمام مجموعه داده ها برگردانده می شوند.

page_token

string

نشانه صفحه، دریافت شده از تماس قبلی ListDatasets. این را برای بازیابی صفحه بعدی ارائه دهید.

tag

string

برچسبی که نسخه مورد نظر را برای هر مجموعه داده مشخص می کند.

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

برچسب "فعال": هر مجموعه داده در پاسخ شامل اطلاعات آخرین نسخه تکمیل شده خود می شود و اگر مجموعه داده ای نداشته باشد از آن صرفنظر می شود.

ListDatasetsResponse

شی پاسخ ListDatasets.

زمینه های
datasets[]

Dataset

تمام مجموعه داده های پروژه

next_page_token

string

نشانه ای که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود.

اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد.

LocalFileSource

جزئیات مربوط به منبع داده زمانی که یک فایل محلی است.

زمینه های
filename

string

نام فایل فایل آپلود شده

file_format

FileFormat

فرمت فایلی که در حال آپلود است.

وضعیت

وضعیت مجموعه داده

زمینه های
state

State

شماره را برای وضعیت اعلام کنید.

error_message

string

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

حالت

لیستی از حالت های مجموعه داده.

Enums
STATE_UNSPECIFIED وضعیت این مجموعه داده تنظیم نشده است.
STATE_IMPORTING داده ها به یک مجموعه داده وارد می شوند.
STATE_IMPORT_SUCCEEDED وارد کردن داده ها به یک مجموعه داده با موفقیت انجام شد.
STATE_IMPORT_FAILED وارد کردن داده به مجموعه داده انجام نشد.
STATE_DELETING مجموعه داده در حال حذف شدن است.
STATE_DELETION_FAILED وضعیت حذف ناموفق بود. این حالت نشان می دهد که حذف مجموعه داده ها ناموفق بوده است. حذف ممکن است دوباره امتحان شود.
STATE_PROCESSING داده ها در حال پردازش است.
STATE_PROCESSING_FAILED وضعیت پردازش ناموفق بود. این حالت نشان می دهد که پردازش ناموفق بوده و ممکن است خطاها را گزارش کند.
STATE_NEEDS_REVIEW این حالت در حال حاضر استفاده نمی شود.
STATE_PUBLISHING وضعیت انتشارات این وضعیت نشان می دهد که انتشار در حال انجام است.
STATE_PUBLISHING_FAILED انتشارات شکست خورده است. این حالت نشان می دهد که انتشار شکست خورده است. انتشار ممکن است دوباره امتحان شود.
STATE_COMPLETED حالت تکمیل شده این حالت نشان دهنده موجود بودن مجموعه داده برای استفاده خاص آن است.

UpdateDatasetMetadataRequest

درخواست به روز رسانی فیلدهای فراداده مجموعه داده.

زمینه های
dataset

Dataset

ضروری. نام منبع مجموعه داده برای به روز رسانی. قالب: projects/{project}/datasets/{dataset_id}

update_mask

FieldMask

لیست فیلدهایی که باید به روز شوند.

مقدار "*" برای جایگزینی کامل (پیش فرض) استفاده می شود.

استفاده

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

Enums
USAGE_UNSPECIFIED استفاده از این مجموعه داده تنظیم نشده است.
USAGE_DATA_DRIVEN_STYLING این مجموعه داده برای یک استایل مبتنی بر داده استفاده خواهد شد.