Package google.maps.mapmanagement.v2beta

فهرست

رابط مدیریت نقشه

تعریف سرویس برای API مدیریت نقشه.

روش‌ها
CreateMapConfig یک MapConfig در یک پروژه ایجاد می‌کند.
CreateMapContextConfig یک MapContextConfig ایجاد می‌کند.
CreateStyleConfig یک StyleConfig ایجاد می‌کند.
DeleteMapConfig یک MapConfig را حذف می‌کند.
DeleteMapContextConfig یک MapContextConfig را حذف می‌کند.
DeleteStyleConfig یک StyleConfig را حذف می‌کند.
GetMapConfig یک MapConfig دریافت می‌کند.
GetMapContextConfig یک MapContextConfig دریافت می‌کند.
GetStyleConfig یک StyleConfig دریافت می‌کند.
ListMapConfigs فهرست MapConfig های یک پروژه را نشان می‌دهد.
ListMapContextConfigs فهرست‌ها MapContextConfigs.
ListStyleConfigs پیکربندی‌های سبک لیست‌ها.
UpdateMapConfig یک MapConfig را به‌روزرسانی می‌کند.
UpdateMapContextConfig یک MapContextConfig را به‌روزرسانی می‌کند.
UpdateStyleConfig یک StyleConfig را به‌روزرسانی می‌کند.

درخواست ایجاد نقشه پیکربندی

درخواست ایجاد MapConfig.

فیلدها
parent

string

الزامی. پروژه والد که مالک MapConfig خواهد بود. فرمت: projects/{project}

map_config

MapConfig

الزامی. MapConfig برای ایجاد.

درخواست ایجاد نقشه زمینه پیکربندی

درخواست ایجاد MapContextConfig.

فیلدها
parent

string

الزامی. فایل والد MapConfig که مالک MapContextConfig خواهد بود. فرمت: projects/{project}/mapConfigs/{map_config}

map_context_config

MapContextConfig

الزامی. MapContextConfig برای ایجاد.

درخواست ایجاد سبک پیکربندی

درخواست ایجاد StyleConfig.

فیلدها
parent

string

الزامی. پروژه والد که مالک StyleConfig خواهد بود. فرمت: projects/{project}

style_config

StyleConfig

الزامی. StyleConfig برای ایجاد.

درخواست حذف نقشه پیکربندی

درخواست حذف MapConfig.

فیلدها
name

string

الزامی. نام MapConfig که قرار است حذف شود. فرمت: projects/{project}/mapConfigs/{map_config}

درخواست پیکربندی حذف نقشه زمینه

درخواست حذف MapContextConfig.

فیلدها
name

string

الزامی. نام MapContextConfig که قرار است حذف شود. فرمت: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

درخواست پیکربندی سبک حذف

درخواست حذف StyleConfig.

فیلدها
name

string

الزامی. نام StyleConfig که قرار است حذف شود. فرمت: projects/{project}/styleConfigs/{style_config}

درخواست پیکربندی GetMap

درخواست دریافت MapConfig.

فیلدها
name

string

الزامی. نام MapConfig مورد نظر برای بازیابی. فرمت: projects/{project}/mapConfigs/{map_config}

درخواست GetMapContextConfig

درخواست دریافت MapContextConfig.

فیلدها
name

string

الزامی. نام MapContextConfig برای بازیابی. قالب: projects/{project}/mapConfigs/{map_config}/mapContextConfigs/{map_context_config}

درخواست GetStyleConfig

درخواست دریافت StyleConfig.

فیلدها
name

string

الزامی. نام StyleConfig برای بازیابی. قالب: projects/{project}/styleConfigs/{style_config}

view

StyleConfigView

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

درخواست پیکربندی نقشه لیست

درخواست فهرست کردن MapConfig های یک پروژه.

فیلدها
parent

string

الزامی. پروژه والد که مالک MapConfigs است. فرمت: projects/{project}

page_size

int32

اختیاری. حداکثر تعداد MapConfigs برای برگرداندن. سرویس ممکن است کمتر از این مقدار را برگرداند. در صورت عدم تعیین، حداکثر ۵۰ MapConfigs برگردانده خواهد شد. حداکثر مقدار ۱۰۰۰ است؛ مقادیر بالاتر از ۱۰۰۰ به ۱۰۰۰ کاهش می‌یابند. در حال حاضر پشتیبانی نمی‌شود.

page_token

string

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

هنگام صفحه‌بندی، تمام پارامترهای دیگر ارائه شده به ListMapConfigs باید با فراخوانی که توکن صفحه را ارائه داده است، مطابقت داشته باشند. در حال حاضر پشتیبانی نمی‌شود.

ListMapConfigsResponse

پاسخ به لیست MapConfigs.

فیلدها
map_configs[]

MapConfig

فهرست MapConfigها.

next_page_token

string

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

درخواست پیکربندی ListMapContextConfigs

درخواست فهرست کردن MapContextConfigها.

فیلدها
parent

string

الزامی. فایل والد MapConfig که مالک MapContextConfigs است. فرمت: projects/{project}/mapConfigs/{map_config}

page_size

int32

اختیاری. حداکثر تعداد MapContextConfigs برای برگرداندن. سرویس ممکن است کمتر از این مقدار را برگرداند. در صورت عدم تعیین، حداکثر ۵۰ MapContextConfigs برگردانده خواهد شد. حداکثر مقدار ۱۰۰۰ است؛ مقادیر بالاتر از ۱۰۰۰ به ۱۰۰۰ کاهش می‌یابند. در حال حاضر پشتیبانی نمی‌شود.

page_token

string

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

هنگام صفحه‌بندی، تمام پارامترهای دیگر ارائه شده به ListMapContextConfigs باید با فراخوانی که توکن صفحه را ارائه داده است، مطابقت داشته باشند. در حال حاضر پشتیبانی نمی‌شود.

ListMapContextConfigsResponse

پاسخ به لیست MapContextConfigs.

فیلدها
map_context_configs[]

MapContextConfig

پیکربندی‌های MapContext.

next_page_token

string

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

درخواست پیکربندی سبک لیست

درخواست فهرست کردن StyleConfigها.

فیلدها
parent

string

الزامی. پروژه والد که مالک StyleConfigs است. فرمت: projects/{project}

page_size

int32

اختیاری. حداکثر تعداد StyleConfigs برای برگرداندن. سرویس ممکن است کمتر از این مقدار را برگرداند. در صورت عدم تعیین، حداکثر ۵۰ StyleConfigs برگردانده خواهد شد. حداکثر مقدار ۱۰۰۰ است؛ مقادیر بالاتر از ۱۰۰۰ به ۱۰۰۰ کاهش می‌یابند. در حال حاضر پشتیبانی نمی‌شود.

page_token

string

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

هنگام صفحه‌بندی، تمام پارامترهای دیگر ارائه شده به ListStyleConfigs باید با فراخوانی که توکن صفحه را ارائه داده است، مطابقت داشته باشند. در حال حاضر پشتیبانی نمی‌شود.

filter

string

اختیاری. عبارت فیلتر برای فراخوانی ListStyleConfigs. در حال حاضر فقط از فیلتر کردن بر اساس display_name پشتیبانی می‌کند. برای مثال: display_name="My StyleConfig" تمام StyleConfigهایی را که نام نمایشی "My StyleConfig" دارند، برمی‌گرداند.

view

StyleConfigView

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

ListStyleConfigsResponse

پاسخ به لیست StyleConfigs.

فیلدها
style_configs[]

StyleConfig

پیکربندی‌های سبک (StyleConfigs).

next_page_token

string

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

نقشه پیکربندی

یک نقشه واحد را در یک برنامه کلاینت Maps API نشان می‌دهد. MapConfig منبع والد MapContextConfigs است و استایل‌بندی سفارشی را در SDKها (موبایل/وب) فعال می‌کند. یک MapConfig می‌تواند چندین MapContextConfig داشته باشد که هر کدام استایل‌بندی را به انواع خاصی از نقشه اعمال می‌کنند. 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 اجزای استایل‌بندی، مانند 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 را نشان می‌دهد. فقط خروجی.

نقشه‌وار

انواع نقشه‌های ممکن که MapContextConfig می‌تواند روی آنها اعمال شود. انواع نقشه به انواع روشن و تیره گروه‌بندی می‌شوند. یک نوع روشن را نمی‌توان با یک نوع تیره برای یک MapContextConfig یکسان جفت کرد. انواع روشن عبارتند از: ROADMAP، SATELLITE، TERRAIN، NAVIGATION، TRANSIT، ABSTRACT3D، PHOTOREALISTIC3D. انواع تیره عبارتند از: 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 نوع نقشه سه‌بعدی واقع‌گرایانه.

ویژگی‌های نقشه

مجموعه‌ای از ویژگی‌های نقشه را نشان می‌دهد که به MapConfig اعمال می‌شوند. ویژگی‌های تنظیم‌شده روی MapConfig توسط تمام MapContextConfigهای فرزند آن به ارث می‌رسند. Next ID = 3;

فیلدها
simple_features[]

SimpleFeature

اختیاری. ویژگی بصری مورد استفاده برای این نقشه.

poi_boost_level

int32

اختیاری. سطح تقویت POI، که در آن ۰ به معنای عدم تقویت و مقادیر منفی به معنای کاهش تقویت است. POI های تقویت شده با بزرگنمایی کمتر از حالت پیش‌فرض و برعکس کاهش تقویت نشان داده می‌شوند. در حال حاضر از ۲ سطح تقویت پشتیبانی می‌کند، بنابراین سطح به [-۲، ۲] محدود می‌شود. در صورت عدم تعیین، چگالی POI تعریف شده در شیوه‌نامه در صورت وجود استفاده خواهد شد. در غیر این صورت، هیچ چگالی POI اعمال نخواهد شد.

ویژگی ساده

این نشان‌دهنده مجموعه‌ای از ویژگی‌های نقشه است که بر ساختار ذاتی نقشه تأثیر می‌گذارند.

انوم‌ها
SIMPLE_FEATURE_UNSPECIFIED ویژگی بصری نامشخص.
FLATTEN_BUILDINGS تمام ساختمان‌های نقشه را مسطح می‌کند.
ICONIC_ICONS بر نحوه نمایش آیکون‌ها تأثیر می‌گذارد.

نوع رندر نقشه

نوع نقشه‌ای که قرار است رندر شود. اگر مشخص نشده باشد، رفتار پیش‌فرض RASTER است.

انوم‌ها
RASTER نقشه‌ای که با استفاده از پیاده‌سازی مبتنی بر رستر رندر شده است.
VECTOR نقشه‌ای که با استفاده از webGL رندر شده است.

پیکربندی سبک

یک سبک واحد را در یک برنامه کلاینت Maps API نشان می‌دهد. StyleConfig شامل برگه سبکی است که ظاهر بصری نقشه را تعریف می‌کند. شناسه بعدی = 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 از style sheet برای این StyleConfig. در صورت مشخص نکردن، از استایل پایه نقشه گوگل استفاده خواهد شد. برای جزئیات بیشتر در مورد فرمت JSON قابل قبول، به https://developers.google.com/maps/documentation/javascript/cloud-customization/json-reference مراجعه کنید.

create_time

Timestamp

فقط خروجی. زمان ایجاد StyleConfig را نشان می‌دهد.

update_time

Timestamp

فقط خروجی. آخرین زمان به‌روزرسانی StyleConfig را نشان می‌دهد.

نمای سبک پیکربندی

چه زیرمجموعه‌ای از StyleConfig را برگرداند.

انوم‌ها
STYLE_CONFIG_VIEW_UNSPECIFIED نمای نامشخص.
FULL json_style_sheet را در پاسخ قرار دهید.
METADATA_ONLY json_style_sheet را از پاسخ حذف کنید.

درخواست پیکربندی به‌روزرسانی نقشه

درخواست به‌روزرسانی MapConfig.

فیلدها
map_config

MapConfig

الزامی. MapConfig برای به‌روزرسانی.

فیلد name MapConfig برای شناسایی MapConfig مورد نظر برای به‌روزرسانی استفاده می‌شود. فرمت: projects/{project}/mapConfigs/{map_config}

update_mask

FieldMask

اختیاری. فیلد خاصی که برای MapConfig به‌روزرسانی می‌شود. اگر مشخص نشود، MapConfig به طور کامل به‌روزرسانی خواهد شد. فیلدهای معتبر عبارتند از:

  • display_name
  • description
  • map_features

درخواست پیکربندی به‌روزرسانی نقشه زمینه

درخواست به‌روزرسانی 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

درخواست پیکربندی سبک به‌روزرسانی

درخواست به‌روزرسانی StyleConfig.

فیلدها
style_config

StyleConfig

الزامی. StyleConfig برای به‌روزرسانی.

فیلد name StyleConfig برای شناسایی StyleConfig مورد نظر برای به‌روزرسانی استفاده می‌شود. فرمت: projects/{project}/styleConfigs/{style_config}

update_mask

FieldMask

اختیاری. فهرست فیلدهایی که باید به‌روزرسانی شوند. اگر مشخص نشود، StyleConfig به‌طور کامل به‌روزرسانی خواهد شد. فیلدهای معتبر عبارتند از:

  • display_name
  • description
  • json_style_sheet