Package google.maps.mapsplatformdatasets.v1alpha

الفهرس

MapsPlatformDatasetsV1Alpha

تعريف الخدمة لواجهة برمجة تطبيقات مجموعات البيانات في "منصة خرائط Google"

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

إنشاء مجموعة بيانات جديدة للمشروع المحدد.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
أذونات إدارة الهوية وإمكانية الوصول

يتطلب إذن إدارة الهوية وإمكانية الوصول التالي على مورد parent:

  • mapsplatformdatasets.datasets.create

لمزيد من المعلومات، اطّلِع على مستندات إدارة الهوية وإمكانية الوصول.

DeleteDataset

rpc DeleteDataset(DeleteDatasetRequest) returns (Empty)

احذف مجموعة البيانات المحددة .

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
أذونات إدارة الهوية وإمكانية الوصول

يتطلب إذن إدارة الهوية وإمكانية الوصول التالي على مورد name:

  • mapsplatformdatasets.datasets.delete

لمزيد من المعلومات، اطّلِع على مستندات إدارة الهوية وإمكانية الوصول.

DownloadDataset

rpc DownloadDataset(DownloadDatasetRequest) returns (DownloadDatasetResponse)

يتم تنزيل مجموعة بيانات.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
أذونات إدارة الهوية وإمكانية الوصول

يتطلب إذن إدارة الهوية وإمكانية الوصول التالي على مورد name:

  • mapsplatformdatasets.datasets.export

لمزيد من المعلومات، اطّلِع على مستندات إدارة الهوية وإمكانية الوصول.

GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

الحصول على مجموعة البيانات.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
أذونات إدارة الهوية وإمكانية الوصول

يتطلب إذن إدارة الهوية وإمكانية الوصول التالي على مورد name:

  • mapsplatformdatasets.datasets.get

لمزيد من المعلومات، اطّلِع على مستندات إدارة الهوية وإمكانية الوصول.

ImportDataset

rpc ImportDataset(ImportDatasetRequest) returns (ImportDatasetResponse)

لاستيراد نسخة جديدة من البيانات لمجموعة البيانات.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
أذونات إدارة الهوية وإمكانية الوصول

يتطلب إذن إدارة الهوية وإمكانية الوصول التالي على مورد name:

  • mapsplatformdatasets.datasets.import

لمزيد من المعلومات، اطّلِع على مستندات إدارة الهوية وإمكانية الوصول.

ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

سرد جميع مجموعات البيانات للمشروع المحدد.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
أذونات إدارة الهوية وإمكانية الوصول

يتطلب إذن إدارة الهوية وإمكانية الوصول التالي على مورد parent:

  • mapsplatformdatasets.datasets.list

لمزيد من المعلومات، اطّلِع على مستندات إدارة الهوية وإمكانية الوصول.

UpdateDatasetMetadata

rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset)

تحديث البيانات الوصفية لمجموعة البيانات.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
أذونات إدارة الهوية وإمكانية الوصول

يتطلب إذن إدارة الهوية وإمكانية الوصول التالي على مورد name:

  • mapsplatformdatasets.datasets.update

لمزيد من المعلومات، اطّلِع على مستندات إدارة الهوية وإمكانية الوصول.

CreateDatasetRequest

طلب إنشاء مجموعة بيانات للخرائط

الحقول
parent

string

مطلوبة. تمثّل هذه السمة المشروع الرئيسي الذي سيمتلك مجموعة البيانات. التنسيق: project/{$project}

dataset

Dataset

مطلوبة. تمثّل هذه السمة نسخة مجموعة البيانات المطلوب إنشاؤها.

مجموعة البيانات

تمثيل لمجموعة بيانات النظام الأساسي للخرائط.

الحقول
name

string

اسم المورد، المشاريع/{project}/مجموعات البيانات/{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

مطلوبة. Format: projects/${project}/datasets/{dataset_id}

DownloadDatasetRequest

طلب تنزيل مجموعة البيانات.

الحقول
name

string

مجموعة البيانات المطلوب جلبها. Format: projects/${project}/datasets/${dataset_id}

DownloadDatasetResponse

استجابة من تنزيل مجموعة البيانات.

FileFormat

تمثّل هذه السمة تنسيق الملف الذي يتم تحميله.

عمليات التعداد
FILE_FORMAT_UNSPECIFIED تنسيق الملف غير محدد.
FILE_FORMAT_GEOJSON GeoJson.
FILE_FORMAT_KML ملف KML.
FILE_FORMAT_CSV بملف CSV.

GcsSource

تفاصيل عن مصدر البيانات عندما يكون في Google Cloud Storage.

الحقول
input_uri

string

معرّف الموارد المنتظم (URI) لبيانات المصدر. مثلاً: gs://my_bucket/my_object

file_format

FileFormat

تنسيق الملف لعنصر Google Cloud Storage. يُستخدم هذا بشكل أساسي للتحقق من الصحة.

GetDatasetRequest

طلب الحصول على مجموعة البيانات المحددة.

الحقول
name

string

مطلوبة. اسم المورد: project/{project}/datasets/{dataset_id}

ImportDatasetRequest

طلب استيراد نسخة جديدة من مجموعة البيانات.

الحقول
name

string

مطلوبة. اسم المورد، المشاريع/{project}/مجموعات البيانات/{dataset_id}

version_description

string

وصف للبيانات الجديدة التي يتم استيرادها.

حقل الاتحاد data_source تفاصيل حول مصدر بيانات مجموعة البيانات. يمكن أن تكون السمة "data_source" واحدة فقط مما يلي:
local_file_source

LocalFileSource

مصدر ملف محلي لمجموعة البيانات للاستيراد لمرة واحدة.

gcs_source

GcsSource

مصدر ملف Google Cloud Storage لمجموعة البيانات لعملية استيراد لمرة واحدة.

ImportDatasetResponse

رد ناتج من استيراد نسخة جديدة من مجموعة البيانات.

الحقول
name

string

مطلوبة. اسم المورد لإصدار مجموعة البيانات الذي تم إنشاؤه حديثًا، project/{project}/datasets/{dataset_id}@{version_id}

ListDatasetsRequest

طلب سرد مجموعات بيانات للمشروع.

الحقول
parent

string

مطلوبة. اسم المشروع لإدراج جميع مجموعات البيانات له.

page_size

int32

الحدّ الأقصى لعدد النُسخ المطلوب عرضها في كل صفحة وفي حال عدم تحديدها (أو عدم توفّرها)، سيتم عرض جميع مجموعات البيانات.

page_token

string

الرمز المميز للصفحة الذي تم استلامه من استدعاء ListDatasets سابق. قم بإدخاله لاسترداد الصفحة التالية.

ListDatasetsResponse

الرد على قائمة مجموعات البيانات للمشروع.

الحقول
datasets[]

Dataset

جميع مجموعات البيانات الخاصة بالمشروع.

next_page_token

string

رمز مميز يمكن إرساله كـ page_token لاسترداد الصفحة التالية. إذا تم حذف هذا الحقل، لن تظهر أي صفحات لاحقة.

LocalFileSource

التفاصيل المتعلّقة بمصدر البيانات عندما يكون ملفًا محليًا.

الحقول
filename

string

اسم الملف الذي تم تحميله وامتداده

file_format

FileFormat

تمثّل هذه السمة تنسيق الملف الذي يتم تحميله.

الحالة

حالة إصدار مجموعة البيانات.

الحقول
state

State

تعداد الحالة للحالة

error_message

string

رسالة خطأ توضح سبب عدم التنفيذ. وتكون فارغة إذا لم تكن مجموعات البيانات في حالة فشل.

الحالة

قائمة بالحالات لمجموعة البيانات.

عمليات التعداد
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

مطلوبة. مجموعة البيانات المطلوب تعديلها. يُستخدم اسم مجموعة البيانات لتحديد مجموعة البيانات المراد تحديثها. يحتوي الاسم على التنسيق: project/{project}/datasets/{dataset_id}

update_mask

FieldMask

قائمة الحقول المطلوب تعديلها. يجب إدخال القيمة "*" لاستبدال الجهاز بالكامل.

الاستخدام

يحدد الاستخدام المكان المراد استخدام البيانات فيه لمعرفة كيفية معالجة البيانات.

عمليات التعداد
USAGE_UNSPECIFIED لم يتم ضبط استخدام مجموعة البيانات هذه.
USAGE_DATA_DRIVEN_STYLING وسيتم استخدام مجموعة البيانات هذه للنمط المستند إلى البيانات.