Package google.maps.mapmanagement.v2alpha

الفهرس

MapManagement

تتيح واجهة Map Management API عمليات الإنشاء والقراءة والتعديل والحذف على موارد "تصميم الخرائط باستخدام السحابة الإلكترونية": MapConfigs وStyleConfigs وMapContextConfigs. باستخدام واجهة برمجة التطبيقات هذه، يمكن للمطوّرين إدارة المظهر المرئي لخرائطهم وتصميمها وفقًا لمواصفاتهم.

CreateMapConfig

rpc CreateMapConfig(CreateMapConfigRequest) returns (MapConfig)

تنشئ هذه الطريقة MapConfig في مشروع.

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

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

  • https://www.googleapis.com/auth/cloud-platform
CreateMapContextConfig

rpc CreateMapContextConfig(CreateMapContextConfigRequest) returns (MapContextConfig)

تنشئ هذه الدالة عنصر MapContextConfig.

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

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

  • https://www.googleapis.com/auth/cloud-platform
CreateStyleConfig

rpc CreateStyleConfig(CreateStyleConfigRequest) returns (StyleConfig)

تنشئ هذه الطريقة StyleConfig.

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

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

  • https://www.googleapis.com/auth/cloud-platform
DeleteMapConfig

rpc DeleteMapConfig(DeleteMapConfigRequest) returns (Empty)

تحذف هذه الطريقة MapConfig.

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

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

  • https://www.googleapis.com/auth/cloud-platform
DeleteMapContextConfig

rpc DeleteMapContextConfig(DeleteMapContextConfigRequest) returns (Empty)

تحذف هذه الطريقة MapContextConfig.

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

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

  • https://www.googleapis.com/auth/cloud-platform
DeleteStyleConfig

rpc DeleteStyleConfig(DeleteStyleConfigRequest) returns (Empty)

تحذف هذه الطريقة StyleConfig.

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

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

  • https://www.googleapis.com/auth/cloud-platform
GetMapConfig

rpc GetMapConfig(GetMapConfigRequest) returns (MapConfig)

تعرض هذه الطريقة MapConfig.

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

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

  • https://www.googleapis.com/auth/cloud-platform
GetMapContextConfig

rpc GetMapContextConfig(GetMapContextConfigRequest) returns (MapContextConfig)

تعرض هذه الدالة MapContextConfig.

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

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

  • https://www.googleapis.com/auth/cloud-platform
GetStyleConfig

rpc GetStyleConfig(GetStyleConfigRequest) returns (StyleConfig)

تعرض هذه السمة StyleConfig.

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

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

  • https://www.googleapis.com/auth/cloud-platform
ListMapConfigs

rpc ListMapConfigs(ListMapConfigsRequest) returns (ListMapConfigsResponse)

تعرض هذه الطريقة قائمة بـ MapConfigs لمشروع معيّن.

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

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

  • https://www.googleapis.com/auth/cloud-platform
ListMapContextConfigs

rpc ListMapContextConfigs(ListMapContextConfigsRequest) returns (ListMapContextConfigsResponse)

تعرض هذه الطريقة قائمة بـ MapContextConfigs.

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

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

  • https://www.googleapis.com/auth/cloud-platform
ListStyleConfigs

rpc ListStyleConfigs(ListStyleConfigsRequest) returns (ListStyleConfigsResponse)

قوائم StyleConfigs

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

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

  • https://www.googleapis.com/auth/cloud-platform
UpdateMapConfig

rpc UpdateMapConfig(UpdateMapConfigRequest) returns (MapConfig)

تعدّل هذه الطريقة MapConfig.

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

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

  • https://www.googleapis.com/auth/cloud-platform
UpdateMapContextConfig

rpc UpdateMapContextConfig(UpdateMapContextConfigRequest) returns (MapContextConfig)

تعدّل هذه الطريقة MapContextConfig.

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

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

  • https://www.googleapis.com/auth/cloud-platform
UpdateStyleConfig

rpc UpdateStyleConfig(UpdateStyleConfigRequest) returns (StyleConfig)

تعديل StyleConfig

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

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

  • https://www.googleapis.com/auth/cloud-platform

CreateMapConfigRequest

طلب إنشاء MapConfig

الحقول
parent

string

الحقل مطلوب. المشروع الرئيسي الذي سيمتلك MapConfig. التنسيق: projects/{$my-project-id}
map_config

MapConfig

الحقل مطلوب. تمثّل هذه السمة MapConfig المطلوب إنشاؤه.

CreateMapContextConfigRequest

طلب إنشاء MapContextConfig

الحقول
parent

string

الحقل مطلوب. عنصر MapConfig الرئيسي الذي سيملك MapContextConfig. التنسيق: projects/{project}/mapConfigs/{map_config}
map_context_config

MapContextConfig

الحقل مطلوب. تمثّل هذه السمة MapContextConfig المطلوب إنشاؤه.

CreateStyleConfigRequest

طلب إنشاء StyleConfig

الحقول
parent

string

الحقل مطلوب. المشروع الرئيسي الذي سيمتلك StyleConfig. التنسيق: projects/{project}
style_config

StyleConfig

الحقل مطلوب. تمثّل هذه السمة StyleConfig المطلوب إنشاؤه.

DeleteMapConfigRequest

طلب حذف MapConfig إذا كان MapConfig يتضمّن أي MapContextConfigs فرعية، سيتم حذفها أيضًا.

الحقول
name

string

الحقل مطلوب. اسم المورد الخاص بـ MapConfig المطلوب حذفه. التنسيق: projects/{project}/mapConfigs/{map_config}
force

bool

اختياريّ. في حال ضبطها على "صحيح"، سيتم أيضًا حذف أي MapContextConfigs من MapConfig هذا. (بخلاف ذلك، لن يعمل الطلب إلا إذا لم يكن MapConfig يحتوي على MapContextConfigs).

DeleteMapContextConfigRequest

طلب حذف MapContextConfig

الحقول
name

string

الحقل مطلوب. اسم المورد الخاص بـ MapContextConfig المطلوب حذفه. التنسيق: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

DeleteStyleConfigRequest

طلب حذف StyleConfig

الحقول
name

string

الحقل مطلوب. اسم المورد الخاص بـ StyleConfig المطلوب حذفه. التنسيق: projects/{project}/styleConfigs/{style_config}

GetMapConfigRequest

طلب الحصول على MapConfig

الحقول
name

string

الحقل مطلوب. اسم المورد الخاص بـ MapConfig التنسيق: projects/{project}/mapConfigs/{map_config}

GetMapContextConfigRequest

طلب الحصول على MapContextConfig

الحقول
name

string

الحقل مطلوب. اسم المورد الخاص بـ MapContextConfig التنسيق: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

GetStyleConfigRequest

طلب الحصول على StyleConfig

الحقول
name

string

الحقل مطلوب. اسم مورد StyleConfig التنسيق: projects/{project}/styleConfigs/{style_config}

ListMapConfigsRequest

طلب إدراج MapConfigs

الحقول
parent

string

الحقل مطلوب. المشروع الرئيسي الذي يملك MapConfigs التنسيق: projects/{project}
page_size

int32

اختياريّ. الحدّ الأقصى لعدد MapConfigs المطلوب عرضه. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 50 MapConfig كحد أقصى. الحد الأقصى للقيمة هو 1000، وسيتم فرض القيمة 1000 على القيم الأعلى من 1000. غير متاحة حاليًا.
page_token

string

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

عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى ListMapConfigs مع الطلب الذي قدّم رمز الصفحة المميز. غير متاحة حاليًا.

ListMapConfigsResponse

استجابة لعرض قائمة MapConfigs

الحقول
map_configs[]

MapConfig

قائمة MapConfigs
next_page_token

string

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

ListMapContextConfigsRequest

طلب إدراج MapContextConfigs

الحقول
parent

string

الحقل مطلوب. تمثّل هذه السمة MapConfig الرئيسية التي تتضمّن MapContextConfigs. التنسيق: projects/{project}/mapConfigs/{map_config}
page_size

int32

اختياريّ. الحدّ الأقصى لعدد MapContextConfigs المطلوب عرضه. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 50 MapContextConfigs كحدّ أقصى. الحد الأقصى للقيمة هو 1000، وسيتم فرض القيمة 1000 على القيم الأعلى من 1000. غير متاح حاليًا.
page_token

string

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

عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى ListMapContextConfigs مع الطلب الذي قدّم رمز الصفحة المميز. غير متاحة حاليًا.

ListMapContextConfigsResponse

استجابة لعرض قائمة MapContextConfigs

الحقول
map_context_configs[]

MapContextConfig

‫MapContextConfigs
next_page_token

string

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

ListStyleConfigsRequest

طلب إدراج StyleConfigs

الحقول
parent

string

الحقل مطلوب. المشروع الرئيسي الذي يملك StyleConfigs. التنسيق: projects/{project}
page_size

int32

اختياريّ. الحد الأقصى لعدد StyleConfigs المطلوب عرضه. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 50 StyleConfig كحدّ أقصى. الحد الأقصى للقيمة هو 1000، وسيتم فرض القيمة 1000 على القيم الأعلى من 1000. غير متاح حاليًا.
page_token

string

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

عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى ListStyleConfigs مع الطلب الذي قدّم رمز الصفحة المميز. غير متاح حاليًا.
filter

string

اختياريّ. تعبير الفلتر لمكالمة ListStyleConfigs لا يتيح حاليًا سوى الفلترة حسب display_name. على سبيل المثال: سيؤدي display_name="My StyleConfig" إلى عرض جميع StyleConfigs التي تحمل الاسم المعروض "My StyleConfig".
view

StyleConfigView

اختياريّ. المجموعة الفرعية من StyleConfig المطلوب عرضها. في حال عدم ضبط هذا الخيار، يكون السلوك التلقائي هو عرض "العرض الكامل".

ListStyleConfigsResponse

ردّ على طلب إدراج StyleConfigs

الحقول
style_configs[]

StyleConfig

‫StyleConfigs
next_page_token

string

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

MapConfig

تمثّل هذه الفئة خريطة واحدة في تطبيق عميل لواجهة Maps API. ‫MapConfig هو المورد الرئيسي لـ MapContextConfigs ويتيح تصميمًا مخصّصًا في حِزم SDK (الأجهزة الجوّالة/الويب). يمكن أن يتضمّن MapConfig عدة MapContextConfigs، يطبّق كل منها أنماطًا على أشكال خرائط معيّنة. Next ID = 9;

الحقول
name

string

النتائج فقط. المعرّف. اسم المورد الخاص بإعدادات MapConfig هذه. على سبيل المثال: "projects/my-project-123/mapConfigs/234". النتائج فقط.
display_name

string

اختياريّ. الاسم المعروض لـ MapConfig هذا، كما يحدّده المستخدم.
description

string

اختياريّ. وصف MapConfig هذا، كما يحدّده المستخدم
map_id

string

النتائج فقط. معرّف الخريطة الخاص بـ MapConfig هذا، ويُستخدَم لتحديد الخريطة في تطبيقات العميل. يتم إنشاء هذا الحقل المخصّص للقراءة فقط عند إنشاء MapConfig. النتائج فقط.
map_features

MapFeatures

اختياريّ. ميزات الخريطة التي تنطبق على إعدادات الخريطة هذه
map_type

MapRenderingType

اختياريّ. تمثّل هذه السمة نوع الخريطة في MapConfig. إذا لم يتم ضبط هذا الخيار، سيكون السلوك التلقائي هو استخدام نوع الخريطة النقطية.
create_time

Timestamp

النتائج فقط. تشير إلى وقت إنشاء إعدادات الخريطة. النتائج فقط.
update_time

Timestamp

النتائج فقط. تشير إلى وقت آخر تعديل أُجري على إعدادات الخريطة. النتائج فقط.

MapContextConfig

تتضمّن هذه الفئة إعدادات الأنماط للخريطة. يربط MapContextConfig بين عناصر التصميم، مثل StyleConfig وDatasets، وبين أشكال خرائط معيّنة من MapConfig. عند تحميل MapConfig في حزمة SDK، يتم تطبيق معلومات الأنماط ومجموعة البيانات من MapContextConfig على أشكال الخرائط المحدّدة. Next ID = 10;

الحقول
name

string

النتائج فقط. المعرّف. اسم المورد الخاص بـ MapContextConfig هذا. على سبيل المثال: projects/{project_id}/mapConfigs/{map_id}/mapContextConfigs/{map_context_config_id}
map_config

string

الحقل مطلوب. اسم مورد MapConfig المرتبط بـ MapContextConfig. التنسيق: projects/{project}/mapConfigs/{map_config}. هذا الحقل مطلوب ولا يمكن إغفاله.
style_config

string

الحقل مطلوب. اسم مورد StyleConfig الذي يضبط نمط MapContextConfig هذا. هذا الحقل مطلوب ولا يمكن إغفاله. التنسيق: projects/{project}/styleConfigs/{style_config}
dataset[]

string

اختياريّ. اسم مورد مجموعة البيانات المرتبط بـ MapContextConfig هذا هذا الحقل اختياري ويمكن حذفه. في حال عدم توفّره، لن يتم ربط أي مجموعات بيانات بـ MapContextConfig. في حال تحديد مجموعة بيانات، سيتم تطبيقها على MapContextConfig. التنسيق: projects/{project}/datasets/{dataset}
alias

string

اختياريّ. اسم MapContextConfig الذي حدّده المستخدم ويمكن قراءته.
map_variants[]

MapVariant

الحقل مطلوب. أنواع الخرائط التي يمكن تطبيق MapContextConfig عليها. إذا كانت فارغة، سيتم تطبيق MapContextConfig تلقائيًا على نوع خريطة ROADMAP فقط.
create_time

Timestamp

النتائج فقط. تشير إلى وقت إنشاء MapContextConfig. النتائج فقط.
update_time

Timestamp

النتائج فقط. تشير إلى وقت آخر تعديل أُجري على MapContextConfig. النتائج فقط.

MapVariant

أنواع الخرائط المحتملة التي يمكن تطبيق MapContextConfig عليها يتم تجميع صيغ الخرائط في صيغتين: فاتحة وداكنة. لا يمكن إقران خيار Light بخيار Dark في MapContextConfig نفسه. تتضمّن أشكال الخرائط الخفيفة ما يلي: خريطة الطريق، والقمر الصناعي، والتضاريس، والملاحة، والنقل العام، وخريطة ثلاثية الأبعاد مجرّدة، وخريطة ثلاثية الأبعاد واقعية. تشمل "الأنواع الداكنة": ROADMAP_DARK وNAVIGATION_LOW_LIGHT وTERRAIN_DARK وTRANSIT_DARK.

على سبيل المثال، ما يلي هو عملية ربط صالحة: {MapContextConfig 1: [ROADMAP, NAVIGATION]} {MapContextConfig 2: [ROADMAP_DARK, NAVIGATION_LOW_LIGHT]}

في ما يلي عملية إقران غير صالحة: {MapContextConfig 1: [ROADMAP, ROADMAP_DARK]}

عمليات التعداد
ROADMAP نوع خريطة الإرشادات التفصيلية التلقائي
ROADMAP_DARK إصدار داكن من نوع خريطة "خريطة الطريق"
SATELLITE صور القمر الصناعي
TERRAIN نوع خريطة التضاريس
TERRAIN_DARK نسخة داكنة من نوع خريطة التضاريس
NAVIGATION نوع خريطة التنقّل
NAVIGATION_LOW_LIGHT إصدار منخفض الإضاءة من نوع خريطة التنقّل
TRANSIT نوع خريطة النقل العام
TRANSIT_DARK نسخة داكنة من نوع خريطة النقل العام
ABSTRACT3D نوع خريطة ثلاثية الأبعاد تجريدية
PHOTOREALISTIC3D نوع الخريطة الثلاثية الأبعاد لصور واقعية

MapFeatures

تمثّل هذه السمة مجموعة من ميزات الخريطة التي تنطبق على MapConfig. يتم توريث الميزات التي تم ضبطها على MapConfig من خلال جميع MapContextConfigs التابعة لها. Next ID = 3;

الحقول
simple_features[]

SimpleFeature

اختياريّ. تمثّل هذه السمة الميزة المرئية التي سيتم استخدامها لهذه الخريطة.
poi_boost_level

int32

اختياريّ. مستوى زيادة الاهتمام بنقاط الاهتمام، حيث يشير الرقم 0 إلى عدم زيادة الاهتمام، وتشير القيم السالبة إلى خفض الاهتمام. تظهر "نقاط الاهتمام" المعزّزة بمستوى تصغير أقل من المستوى التلقائي، والعكس صحيح بالنسبة إلى "نقاط الاهتمام" غير المعزّزة. يتيح حاليًا مستويَين من التحسين، لذا يتم حصر المستوى في النطاق [-2, 2]. في حال عدم تحديدها، سيتم استخدام كثافة نقاط الاهتمام المحدّدة في ورقة الأنماط إذا كانت متوفرة. وفي الحالات الأخرى، لن يتم تطبيق أي كثافة لنقاط الاهتمام.

SimpleFeature

يمثّل هذا العنصر مجموعة من عناصر الخريطة التي تؤثّر في البنية الأساسية للخريطة.

عمليات التعداد
SIMPLE_FEATURE_UNSPECIFIED سمة مرئية غير محدّدة
FLATTEN_BUILDINGS تسطيح جميع المباني في الخريطة
ICONIC_ICONS تؤثّر في طريقة عرض الرموز.

MapRenderingType

نوع الخريطة التي سيتم عرضها. الإعداد التلقائي هو RASTER في حال عدم تحديده.

عمليات التعداد
RASTER خريطة معروضة باستخدام التنفيذ المستند إلى الصور النقطية
VECTOR خريطة معروضة باستخدام WebGL

StyleConfig

تمثّل هذه السمة نمطًا واحدًا في تطبيق عميل لواجهة Maps API. يحتوي StyleConfig على ورقة الأنماط التي تحدّد المظهر المرئي للخريطة. Next ID = 9;

الحقول
name

string

النتائج فقط. المعرّف. اسم المورد الخاص بـ StyleConfig هذا على سبيل المثال: "projects/my-project-123/styleConfigs/234".
display_name

string

اختياريّ. الاسم المعروض لـ StyleConfig هذا، كما يحدّده المستخدم.
description

string

اختياريّ. وصف StyleConfig هذا، كما يحدّده المستخدم.
style_id

string

النتائج فقط. المعرّف الفريد لهذا النمط. هذا حقل للقراءة فقط يتم إنشاؤه عند إنشاء StyleConfig. النتائج فقط.
json_style_sheet

string

اختياريّ. تمثيل JSON لورقة الأنماط الخاصة بـ StyleConfig هذا في حال عدم تحديدها، سيتم استخدام نمط "خرائط Google" الأساسي. راجِع https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference لمزيد من التفاصيل حول تنسيق JSON المقبول.
create_time

Timestamp

النتائج فقط. تشير إلى وقت إنشاء StyleConfig.
update_time

Timestamp

النتائج فقط. تشير إلى وقت آخر تعديل لـ StyleConfig.

StyleConfigView

مجموعة فرعية من StyleConfig المطلوب عرضها.

عمليات التعداد
STYLE_CONFIG_VIEW_UNSPECIFIED طريقة عرض غير محدّدة
FULL ضمِّن json_style_sheet في الرد.
METADATA_ONLY استبعِد json_style_sheet من الردّ.

UpdateMapConfigRequest

طلب تعديل MapConfig

الحقول
map_config

MapConfig

الحقل مطلوب. تمثّل هذه السمة MapConfig المطلوب تعديله.

يتم استخدام حقل name في MapConfig لتحديد MapConfig المطلوب تعديله. التنسيق: projects/{project}/mapConfigs/{map_config}
update_mask

FieldMask

اختياريّ. الحقل المحدّد الذي سيتم تعديله في MapConfig. في حال عدم تحديدها، سيتم تعديل MapConfig بالكامل. الحقول الصالحة هي:

  • display_name
  • description
  • map_features

UpdateMapContextConfigRequest

طلب تعديل MapContextConfig

الحقول
map_context_config

MapContextConfig

الحقل مطلوب. تمثّل هذه السمة إعدادات MapContextConfig التي سيتم تعديلها.

يُستخدَم الحقل name في MapContextConfig لتحديد MapContextConfig المطلوب تعديله. التنسيق: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}
update_mask

FieldMask

اختياريّ. قائمة الحقول التي سيتم تعديلها. في حال عدم تحديدها، سيتم تعديل MapContextConfig بالكامل. الحقول الصالحة هي:

  • display_name
  • alias
  • map_variants
  • style_config
  • dataset

UpdateStyleConfigRequest

طلب تعديل StyleConfig

الحقول
style_config

StyleConfig

الحقل مطلوب. تمثّل هذه السمة StyleConfig المطلوب تعديله.

يُستخدَم الحقل name في StyleConfig لتحديد StyleConfig المطلوب تعديله. التنسيق: projects/{project}/styleConfigs/{style_config}
update_mask

FieldMask

اختياريّ. قائمة الحقول التي سيتم تعديلها. إذا لم يتم تحديدها، سيتم تعديل StyleConfig بالكامل. الحقول الصالحة هي:

  • display_name
  • description
  • json_style_sheet