کد جلسه بخشی از داده (یک
UUID)
است که در تماس‌های REST برای شناسایی یک
جلسه—یک
سری از تبادل پیام‌های مرتبط استفاده می‌شود. باید در همه درخواست‌ها برای «کاشی‌های دوبعدی» و تصاویر «نمای خیابان» یک کد جلسه اضافه کنید.
آن را به‌عنوان مقدار پارامتر session که به همه نشانی‌های وب درخواست پیوست شده است اضافه می‌کنید.
در Map Tiles API، کد جلسه نشان‌دهنده مجموعه تعریف‌شده‌ای از
گزینه‌های نمایش است. این یعنی لازم نیست با هر درخواست کاشی، مجموعه‌ای از گزینه‌های نمایش را ارسال کنید. می‌توانید از یک کد جلسه در چندین کارخواه استفاده کنید.
درحال‌حاضر کد جلسه به‌مدت دو هفته از زمان صدور آن معتبر است، اما ممکن است این مدت تغییر کند. همیشه می‌توانید زمان انقضای کد جلسه را با نگاه کردن به فیلد expiry در پیام پاسخ بررسی کنید.
درخواست کد جلسه
برای درخواست کد جلسه، یک درخواست HTTPS POST به نقطه پایانی createSession ارسال کنید، همان‌طور که در مثال زیر نشان داده شده است. باید درخواست را با
سرصفحه Content-Type: application/json ارسال کنید.
curl -X POST -d '{ "mapType": "streetview", "language": "en-US", "region": "US" }' \ -H 'Content-Type: application/json' \ "https://tile.googleapis.com/v1/createSession?key=YOUR_API_KEY"
قسمت‌های الزامی
mapTypeنوع نقشه مبنا. این مقدار می‌تواند یکی از موارد زیر باشد:
roadmap- قطعه‌های نقشه رنگ‌شده استاندارد Google Maps.
satellite- تصاویر ماهواره‌ای.
terrain- تصاویر عوارض زمین. وقتی
terrainرا به‌عنوان نوع نقشه انتخاب می‌کنید، باید نوع لایهlayerRoadmapرا نیز اضافه کنید (در بخش فیلدهای اختیاری توضیح داده شده است). streetview- تمام‌نمای «نمای خیابان». برای اطلاعات بیشتر، به کاشی‌های «نمای خیابان» مراجعه کنید.
languageبرچسب زبان IETF که زبان مورداستفاده برای نمایش اطلاعات در کاشی‌ها را مشخص می‌کند. برای مثال،
en-USزبان انگلیسی را که در ایالات متحده صحبت می‌شود مشخص می‌کند.regionشناسه منطقه مخزن داده‌های محلی مشترک (دو حرف بزرگ) که مکان فیزیکی کاربر را نشان می‌دهد. به‌عنوان مثال،
US.
فیلدهای اختیاری
imageFormat- قالب فایل را برای برگرداندن مشخص می‌کند. مقادیر معتبر
jpegیاpngاست. فایل‌های JPEG از شفافیت پشتیبانی نمی‌کنند، بنابراین برای کاشی‌های هم‌پوشان توصیه نمی‌شوند. اگرimageFormatرا مشخص نکنید، بهترین قالب برای کاشی به‌طور خودکار انتخاب می‌شود. scaleاندازه عناصر نقشه (مانند برچسب‌های جاده) را افزایش می‌دهد، درحالی‌که اندازه کاشی و منطقه تحت پوشش کاشی پیش‌فرض را حفظ می‌کند. افزایش مقیاس همچنین تعداد برچسب‌های روی نقشه را کاهش می‌دهد که باعث کاهش درهم‌ریختگی می‌شود. مقادیر زیر مقادیر معتبر
scaleهستند:scaleFactor1x: پیش‌فرض.-
scaleFactor2x: اندازه برچسب را دوبرابر می‌کند و برچسب‌های ویژگی‌های جزئی را برمی‌دارد. -
scaleFactor4x: اندازه برچسب را چهار برابر می‌کند و برچسب‌های ویژگی‌های جزئی را برمی‌دارد.
مثال‌های زیر تأثیر مقیاس‌بندی عناصر نقشه را نشان می‌دهد.
| ضریب مقیاس ۱ برابر | ضریب مقیاس ۲ برابر |
|---|---|
 |
 |
highDpi- مشخص می‌کند که آیا کاشی‌های با وضوح بالا برگردانده شوند یا نه. اگر ضریب مقیاس افزایش یابد، از
highDpiبرای افزایش اندازه کاشی استفاده می‌شود. معمولاً، افزایش ضریب مقیاس، کاشی حاصل را به تصویری با همان اندازه بزرگ می‌کند که کیفیت را کاهش می‌دهد. باhighDpi، اندازه نهایی نیز افزایش می‌یابد و کیفیت حفظ می‌شود. DPI مخفف «نقطه در اینچ» است و DPI بالا یعنی کاشی بااستفاده از نقطه در اینچ بیشتری نسبت‌به حالت عادی رندر می‌شود. اگرtrue، تعداد پیکسل‌ها در هریک از ابعاد x و y در ضریب مقیاس (یعنی ۲ برابر یا ۴ برابر) ضرب می‌شود. منطقه تحت پوشش کاشی بدون تغییر باقی می‌ماند. این پارامتر فقط با مقادیرscale۲ برابر یا ۴ برابر کار می‌کند. این تنظیم بر کاشی‌های مقیاس ۱ برابر تأثیری ندارد.
| ضریب مقیاس ۱ برابر | ضریب مقیاس ۲ برابر DPI بالا |
|---|---|
|
 |
layerTypesآرایه‌ای از مقادیر که انواع لایه‌های اضافه‌شده به نقشه را مشخص می‌کند. مقادیر معتبر عبارتند از:
layerRoadmap- اگر
terrainرا به‌عنوان نوع نقشه مشخص کنید، الزامی است. همچنین می‌تواند به‌صورت اختیاری روی نوع نقشهsatelliteهم‌پوشانی شود. تأثیری بر کاشی‌های نقشه راه ندارد. layerStreetview- خیابان‌ها و مکان‌های فعال‌شده در «نمای خیابان» را بااستفاده از خطوط آبی روی نقشه نشان می‌دهد.
layerTraffic- وضعیت ترافیک فعلی را نمایش می‌دهد.
stylesآرایه‌ای از اشیای سبک JSON که ظاهر و سطح جزئیات عارضه‌های نقشه مانند جاده‌ها، پارک‌ها، و مناطق ساخته‌شده را مشخص می‌کند. از سبک‌بندی برای سفارشی‌سازی نقشه مبنای استاندارد Google استفاده می‌شود. پارامتر
stylesفقط درصورتی معتبر است که نوع نقشهroadmapباشد. برای نحو کامل سبک، مرجع سبک را ببینید.overlayمقدار بولی که مشخص می‌کند
layerTypesباید به‌عنوان هم‌پوشانی جداگانه ارائه شود یا با تصاویر پایه ترکیب شود. وقتیtrue، نقشه مبنا نمایش داده نمی‌شود. اگر هیچlayerTypesتعریف نکرده‌اید، این مقدار نادیده گرفته می‌شود.
برای مثال، درخواست نوع نقشه satellite با لایه layerRoadmap، و
overlay تنظیم‌شده روی false منجر به کاشی‌های معادل نوع نقشه hybrid
استفاده‌شده در Maps JavaScript API می‌شود (تصویر سمت راست). همان
انواع نقشه و لایه با overlay تنظیم‌شده روی true منجر به کاشی شفاف
با رونهاد نقشه می‌شود که به‌طور مناسب برای رونهاد کردن روی تصاویر ماهواره‌ای
(تصویر سمت راست) سبک‌بندی شده است.
overlay: نادرست |
overlay: درست |
|---|---|
 |
 |
JSON زیر نمونه‌ای از بدنه درخواست معمولی است که هم فیلدهای الزامی و هم فیلدهای اختیاری را شامل می‌شود.
{
"mapType": "satellite",
"language": "en-US",
"region": "us",
"layerTypes": [ "layerRoadmap", "layerStreetview" ],
"overlay": true,
"scale": "scaleFactor1x",
"styles": [
{
"stylers": [
{ "hue": "#00ffe6" },
{ "saturation": -20 }
]
},{
"featureType": "road",
"elementType": "geometry",
"stylers": [
{ "lightness": 100 },
{ "visibility": "simplified" }
]
}
]
}
این مثال هم‌پوشانی‌ای را ارائه می‌دهد که برای ترکیب با تصاویر ماهواره‌ای مناسب است. این نمونه شامل هم نقشه راه و هم رونهاد نمای خیابان است. نقشه حاصل با نام‌ها و داده‌ها به زبان انگلیسی، همان‌طور که در ایالات متحده صحبت می‌شود، ارائه می‌شود.
پاسخ کد جلسه
JSON زیر نمونه‌ای از بدنه پاسخ است.
{
"session": "IgAAAHGU9jnAU4KOAfwY3Bcd6eH_WxQsyocSBAdUnAr9pnvTTNXtF9c_27RBo94ytEXTDg",
"expiry": "1361828036",
"tileWidth": 256,
"tileHeight": 256,
"imageFormat": "png"
}
فهرست زیر حاوی تعاریف فیلدهای موجود در بدنه پاسخ است.
session- مقدار کد جلسه که باید در همه درخواست‌های Map Tiles API خود اضافه کنید.
expiry- رشته‌ای که حاوی زمان (به ثانیه از تاریخ) انقضای کد است. کد جلسه از زمان ایجاد آن به‌مدت دو هفته معتبر است، اما این خط‌مشی ممکن است بدون اطلاع قبلی تغییر کند.
tileWidth- عرض کاشی‌ها به پیکسل اندازه‌گیری می‌شود.
tileHeight- ارتفاع کاشی‌ها به پیکسل اندازه‌گیری می‌شود.
imageFormat- قالب تصویر که می‌تواند
pngیاjpegباشد.