Package google.maps.mapsplatformdatasets.v1

الفهرس

MapsPlatformDatasets

تعريف الخدمة لواجهة برمجة تطبيقات مجموعات البيانات في "منصة خرائط 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

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

rpc FetchDatasetErrors(FetchDatasetErrorsRequest) returns (FetchDatasetErrorsResponse)

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

نطاقات الأذونات

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

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

يجب الحصول على إذن إدارة الهوية وإمكانية الوصول التالي في مورد "dataset":

  • mapsplatformdatasets.datasets.get

ولمزيد من المعلومات، اطّلِع على مستندات إدارة الهوية وإمكانية الوصول.
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

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

عنصر الاستجابة لـ 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

الأخطاء المرتبطة بمجموعة بيانات.

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}

يمكن أيضًا استرجاع بعض الإصدارات الخاصة من خلال إلحاق "@" وعلامة. التنسيق: projects/{project}/datasets/{dataset_id}@{tag}

العلامة "active" (نشط): سيتم تضمين معلومات آخر نسخة مكتملة، و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

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

ListDatasetsRequest

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

الحقول
parent

string

مطلوب. اسم المشروع لسرد جميع مجموعات البيانات الخاصة به. التنسيق: projects/{project}
page_size

int32

تمثّل هذه السمة الحد الأقصى لعدد مجموعات البيانات المطلوب عرضها لكل صفحة.

إذا لم تكن محددة (أو صفرًا)، فسيتم عرض جميع مجموعات البيانات.
page_token

string

الرمز المميّز للصفحة، الذي تم تلقّيه من استدعاء ListDatasets السابق. يمكنك توفير هذا الحقل لاسترداد الصفحة التالية.
tag

string

يشير ذلك المصطلح إلى العلامة التي تحدِّد الإصدار المطلوب لكل مجموعة بيانات.

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

العلامة "active" (نشط): ستتضمّن كل مجموعة بيانات في الردّ معلومات عن آخر نسخة مكتملة لها، وسيتم تخطّي مجموعة البيانات إذا لم تحتوي على أي نسخة.

ListDatasetsResponse

كائن الاستجابة ListDatasets.

الحقول
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 سيتم استخدام مجموعة البيانات هذه للتصميم المستند إلى البيانات.