Package google.maps.mapsplatformdatasets.v1alpha

الفهرس

MapsPlatformDatasetsV1Alpha

تعريف الخدمة لواجهة برمجة التطبيقات Maps Platform Datasets API

CreateDataset

rpc CreateDataset(CreateDatasetRequest) returns (Dataset)

أنشئ مجموعة بيانات جديدة للمشروع المحدّد.

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

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

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

يتطلّب الإذن التالي في IAM على مورد parent:

  • mapsplatformdatasets.datasets.create

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

rpc DeleteDataset(DeleteDatasetRequest) returns (Empty)

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

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

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

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

يتطلّب الإذن التالي في IAM على مورد name:

  • mapsplatformdatasets.datasets.delete

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

rpc DownloadDataset(DownloadDatasetRequest) returns (DownloadDatasetResponse)

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

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

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

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

يتطلّب الإذن التالي في IAM على مورد name:

  • mapsplatformdatasets.datasets.export

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

rpc GetDataset(GetDatasetRequest) returns (Dataset)

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

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

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

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

يتطلّب الإذن التالي في IAM على مورد name:

  • mapsplatformdatasets.datasets.get

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

rpc ImportDataset(ImportDatasetRequest) returns (ImportDatasetResponse)

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

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

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

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

يتطلّب الإذن التالي في IAM على مورد name:

  • mapsplatformdatasets.datasets.import

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

rpc ListDatasetErrors(ListDatasetErrorsRequest) returns (ListDatasetErrorsResponse)

الحصول على جميع أخطاء مجموعة البيانات (لا يعمل هذا الخيار حاليًا إلا في حالة استخدام DDS)

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

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

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

يتطلّب الإذن التالي في IAM على مورد name:

  • mapsplatformdatasets.datasets.get

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

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

تعرض هذه الطريقة جميع مجموعات البيانات للمشروع المحدّد.

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

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

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

يتطلّب الإذن التالي في IAM على مورد parent:

  • mapsplatformdatasets.datasets.list

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

rpc UpdateDatasetMetadata(UpdateDatasetMetadataRequest) returns (Dataset)

عدِّل البيانات الوصفية لمجموعة البيانات.

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

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

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

يتطلّب الإذن التالي في IAM على مورد name:

  • mapsplatformdatasets.datasets.update

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

CreateDatasetRequest

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

الحقول
parent

string

مطلوب. المشروع الرئيسي الذي سيمتلك مجموعة البيانات. التنسيق: projects/{$project}
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}

DownloadDatasetRequest

قدِّم طلبًا لتنزيل مجموعة البيانات.

الحقول
name

string

مجموعة البيانات المطلوب استرجاعها. التنسيق: 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

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

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

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

الحقول
name

string

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

ListDatasetErrorsRequest

طلب لعرض الأخطاء التفصيلية التي تنتمي إلى مجموعة بيانات

الحقول
name

string

مطلوب. التنسيق: projects/${project}/datasets/{dataset_id}
page_size

int32

الحدّ الأقصى لعدد الإصدارات التي سيتم عرضها في كل صفحة القيمة التلقائية هي 10.
page_token

string

الرمز المميّز للصفحة الذي تم تلقّيه من طلب ListDatasetErrors سابق. قدِّم هذه السلسلة لاسترداد الصفحة التالية.

ListDatasetErrorsResponse

ردّ ListDatasetErrors تعرض هذه السمة سلسلة متكررة لرسائل الخطأ.

الحقول
error_messages[]

string

الأخطاء التي تنتمي إلى مجموعة بيانات
next_page_token

string

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

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

مطلوب. مجموعة البيانات التي سيتم تعديلها يُستخدَم اسم مجموعة البيانات لتحديد مجموعة البيانات المطلوب تعديلها. يكون الاسم بالتنسيق: projects/{project}/datasets/{dataset_id}
update_mask

FieldMask

قائمة الحقول التي سيتم تعديلها إتاحة القيمة "*" للاستبدال الكامل

الاستخدام

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

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