Geocoder

کلاس Geocoder

google.maps.Geocoder کلاس
کتابخانه "geocoding"

سرویسی برای تبدیل نشانی به LatLng و برعکس.

const {Geocoder} = await google.maps.importLibrary("geocoding");

سازنده
Geocoder	Geocoder() پارامترها: هیچ نمونه جدیدی از Geocoder ایجاد می‌کند که درخواست‌های زمین‌کدیابی را به سرورهای Google ارسال می‌کند.

روش‌ها
geocode	geocode(request[, callback]) پارامترها: ‫request:‏ GeocoderRequest ‫callback:‏ function(Array<GeocoderResult> optional, GeocoderStatus): void optional مقدار برگشتی: Promise<GeocoderResponse> زمین‌کدیابی درخواست.

میانای GeocoderRequest

میانا google.maps.GeocoderRequest

مشخصات درخواست زمین‌کدیابی که باید به Geocoder ارسال شود.

مشخصات
address اختیاری	نوع: string optional نشانی برای زمین‌کدیابی. فقط یکی از address، location، و placeId باید ارائه شود.
bounds اختیاری	نوع: LatLngBounds|LatLngBoundsLiteral optional LatLngBounds که باید در آن جستجو شود. اختیاری.
componentRestrictions اختیاری	نوع: GeocoderComponentRestrictions optional از مؤلفه‌ها برای محدود کردن نتایج به منطقه‌ای خاص استفاده می‌شود. فیلتر از یک یا چند مورد از این‌ها تشکیل شده است: route، locality، administrativeArea، postalCode، country. فقط نتایجی که با همه فیلترها مطابقت داشته باشند برگردانده می‌شوند. مقادیر فیلتر از همان روش‌های تصحیح املایی و تطابق جزئی مانند سایر درخواست‌های زمین‌کدیابی پشتیبانی می‌کنند. اختیاری.
extraComputations اختیاری	توجه: فقط در کانال v=beta دردسترس است. نوع: Array<ExtraGeocodeComputation> optional فهرستی از محاسبات اضافی که ممکن است برای تکمیل درخواست استفاده شود. توجه: این محاسبات اضافی ممکن است فیلدهای اضافی را در پاسخ برگرداند.
fulfillOnZeroResults اختیاری	نوع: boolean optional درصورت وجود وضعیت ZERO_RESULT در پاسخ، به وعده عمل کنید. این ممکن است مطلوب باشد زیرا حتی با صفر نتیجه زمین‌کدیابی، ممکن است هنوز فیلدهای سطح پاسخ اضافی برگردانده شود.
language اختیاری	نوع: string optional شناسه زبان برای زبانی که نتایج باید به آن برگردانده شود (درصورت امکان). فهرست زبان‌های پشتیبانی‌شده را ببینید.
location اختیاری	نوع: LatLng|LatLngLiteral optional LatLng (یا LatLngLiteral) برای جستجو. زمین‌کدیاب زمین‌کدیابی معکوس انجام می‌دهد. برای اطلاعات بیشتر، زمین‌کدیابی معکوس را ببینید. فقط یکی از address، location، و placeId باید ارائه شود.
placeId اختیاری	نوع: string optional شناسه مکان مرتبط با مکان. «شناسه مکان» به‌طور منحصربه‌فرد مکانی را در پایگاه داده Google Places و در Google Maps شناسایی می‌کند. درباره شناسه‌های جا در راهنمای توسعه‌دهنده Places API بیشتر بدانید. زمین‌کدیاب زمین‌کدیابی معکوس انجام می‌دهد. برای اطلاعات بیشتر، زمین‌کدیابی معکوس را ببینید. فقط یکی از address، location، و placeId باید ارائه شود.
region اختیاری	نوع: string optional کد کشور استفاده‌شده برای سوگیری جستجو، که به‌عنوان برچسب فرعی منطقه «یونی‌کد» / شناسه CLDR دو نویسه‌ای (غیرعددی) مشخص شده است. اختیاری. برای مناطق پشتیبانی‌شده، جزئیات پوشش پلاتفرم Google Maps را ببینید.

میانای GeocoderComponentRestrictions

میانا google.maps.GeocoderComponentRestrictions

GeocoderComponentRestrictions نشان‌دهنده مجموعه‌ای از فیلترها است که به منطقه خاصی منتهی می‌شود. برای جزئیات بیشتر درباره نحوه عملکرد این ویژگی، به فیلتر کردن مؤلفه زمین‌کدیابی مراجعه کنید.

مشخصات
administrativeArea اختیاری	نوع: string optional با همه administrative_area levels مطابقت دارد. اختیاری.
country اختیاری	نوع: string optional با نام کشور یا کد کشور دوحرفی ISO 3166-1 مطابقت دارد. اختیاری.
locality اختیاری	نوع: string optional با هر دو نوع locality و sublocality مطابقت دارد. اختیاری.
postalCode اختیاری	نوع: string optional با postal_code و postal_code_prefix مطابقت دارد. اختیاری.
route اختیاری	نوع: string optional با نام کوتاه یا بلند route مطابقت دارد. اختیاری.

ثابت‌های ExtraGeocodeComputation

google.maps.ExtraGeocodeComputation ثابت‌ها
کتابخانه "geocoding"

توجه: فقط در کانال v=beta دردسترس است.

محاسبات اضافی که باید هنگام تکمیل درخواست زمین‌کدیابی انجام شود.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع ExtraGeocodeComputationString تعریف می‌شوند.

const {ExtraGeocodeComputation} = await google.maps.importLibrary("geocoding");

ثابت‌ها
ADDRESS_DESCRIPTORS	تولید توصیف‌گر نشانی.

ثابت‌های GeocoderStatus

google.maps.GeocoderStatus ثابت‌ها
کتابخانه "geocoding"

وضعیت برگردانده‌شده توسط Geocoder در تکمیل تماس با geocode(). این‌ها را براساس مقدار یا بااستفاده از نام ثابت مشخص کنید. برای مثال، 'OK' یا google.maps.GeocoderStatus.OK.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع GeocoderStatusString تعریف می‌شوند.

const {GeocoderStatus} = await google.maps.importLibrary("geocoding");

ثابت‌ها
ERROR	مشکلی در تماس با سرورهای Google وجود داشت.
INVALID_REQUEST	این GeocoderRequest نامعتبر بود.
OK	پاسخ حاوی GeocoderResponse معتبر است.
OVER_QUERY_LIMIT	صفحه وب در مدت زمان بسیار کوتاهی از حد مجاز درخواست‌ها فراتر رفته است.
REQUEST_DENIED	صفحه وب اجازه ندارد از زمین‌کدیاب استفاده کند.
UNKNOWN_ERROR	به‌دلیل خطای سرور، درخواست زمین‌کدیابی پردازش نشد. اگر دوباره امتحان کنید، ممکن است درخواست موفقیت‌آمیز باشد.
ZERO_RESULTS	هیچ نتیجه‌ای برای این GeocoderRequest پیدا نشد.

میانای GeocoderResponse

میانا google.maps.GeocoderResponse

پاسخ Geocoder که توسط Geocoder برگردانده شده است و حاوی فهرست GeocoderResult است.

مشخصات
results	نوع: Array<GeocoderResult> فهرست GeocoderResult.
address_descriptor اختیاری	توجه: فقط در کانال v=beta دردسترس است. نوع: AddressDescriptor optional شرح نسبی مکان. شامل مجموعه‌ای رتبه‌بندی‌شده از نشانگرهای مکانی اطراف و مناطقی است که مکان هدف را دربرمی‌گیرد. این فیلد فقط برای درخواست‌های زمین‌کدیابی معکوس و فقط زمانی که ExtraGeocodeComputation.ADDRESS_DESCRIPTORS فعال باشد پُر می‌شود.
plus_code اختیاری	نوع: PlacePlusCode optional Plus Code مرتبط با مکان.

میانای GeocoderResult

میانا google.maps.GeocoderResult

یک نتیجه زمین‌کدیاب از سرور زمین‌کدیاب بازیابی شد. درخواست زمین‌کدیاب ممکن است چندین شیء نتیجه برگرداند. توجه داشته باشید که اگرچه این نتیجه «شبیه JSON» است، اما دقیقاً JSON نیست، زیرا به‌طور غیرمستقیم شامل یک شیء LatLng است.

مشخصات
address_components	نوع: Array<GeocoderAddressComponent> آرایه‌ای از GeocoderAddressComponent
formatted_address	نوع: string رشته‌ای که حاوی نشانی قابل‌خواندن برای انسان از این مکان است.
geometry	نوع: GeocoderGeometry یک شیء GeocoderGeometry
place_id	نوع: string شناسه مکان مرتبط با مکان. «شناسه مکان» به‌طور منحصربه‌فرد مکانی را در پایگاه داده Google Places و در Google Maps شناسایی می‌کند. درباره شناسه‌های جا در راهنمای توسعه‌دهنده Places API بیشتر بدانید.
types	نوع: Array<string> آرایه‌ای از رشته‌ها که نوع عنصر زمین‌کدیابی‌شده برگردانده‌شده را نشان می‌دهد. برای مشاهده فهرست رشته‌های ممکن، به بخش انواع مؤلفه نشانی در «راهنمای توسعه‌دهنده» مراجعه کنید.
address_descriptor اختیاری	توجه: فقط در کانال v=beta دردسترس است. نوع: AddressDescriptor optional شرح رابطه‌ای مکان مرتبط با این زمین‌کد. شامل مجموعه‌ای رتبه‌بندی‌شده از نشانگرهای مکانی اطراف و مناطقی است که مکان هدف را دربرمی‌گیرند. این مورد فقط برای درخواست‌های زمین‌کدیابی مستقیم و جستجوی شناسه مکان، فقط وقتی ExtraGeocodeComputation.ADDRESS_DESCRIPTORS فعال باشد، و فقط برای مکان‌های بومی‌سازی‌شده خاصی درج می‌شود.
partial_match اختیاری	نوع: boolean optional آیا زمین‌کدیاب برای درخواست اصلی مطابقت دقیقی برنگردانده است، هرچند توانسته است بخشی از نشانی درخواست‌شده را مطابقت دهد. اگر تطابق کامل باشد، مقدار undefined خواهد بود.
plus_code اختیاری	نوع: PlacePlusCode optional Plus Code مرتبط با مکان.
postcode_localities اختیاری	نوع: Array<string> optional آرایه‌ای از رشته‌ها که همه محل‌های موجود در کد پستی را نشان می‌دهد. این مورد فقط زمانی وجود دارد که نتیجه یک کد پستی باشد که شامل چندین منطقه است.

میانای AddressDescriptor

میانا google.maps.AddressDescriptor

توجه: فقط در کانال v=beta دردسترس است.

شرح نسبی مکان. شامل مجموعه‌ای رتبه‌بندی‌شده از نشانگرهای مکانی اطراف و مناطقی است که مکان هدف را دربرمی‌گیرند.

مشخصات
areas	نوع: Array<Area> فهرست رتبه‌بندی‌شده‌ای از مناطق دربرگیرنده یا مجاور. مفیدترین (قابل‌تشخیص‌ترین و دقیق‌ترین) مناطق در رتبه اول قرار می‌گیرند.
landmarks	نوع: Array<Landmark> فهرست رتبه‌بندی‌شده‌ای از نشانگرهای مکانی اطراف. مفیدترین نشانگرهای مکانی (قابل‌تشخیص و نزدیک) در رتبه اول قرار می‌گیرند.

میانای GeocoderAddressComponent

میانا google.maps.GeocoderAddressComponent

یک مؤلفه نشانی تکی در GeocoderResult. نشانی کامل ممکن است از چندین مؤلفه نشانی تشکیل شده باشد.

مشخصات
long_name	نوع: string متن کامل مؤلفه نشانی
short_name	نوع: string نوشتار کوتاه و مخفف مؤلفه نشانی ارائه‌شده
types	نوع: Array<string> آرایه‌ای از رشته‌ها که نوع این مؤلفه نشانی را نشان می‌دهد. فهرست انواع معتبر را می‌توانید اینجا ببینید

میانای GeocoderGeometry

میانا google.maps.GeocoderGeometry

اطلاعات هندسی درباره این GeocoderResult

مشخصات
location	نوع: LatLng مختصات طول/عرض جغرافیایی این نتیجه
location_type	نوع: GeocoderLocationType نوع مکان برگردانده‌شده در location
viewport	نوع: LatLngBounds مرزهای نمای توصیه شده برای نمایش این GeocoderResult
bounds اختیاری	نوع: LatLngBounds optional مرزهای دقیق این GeocoderResult، درصورت وجود

ثابت‌های GeocoderLocationType

google.maps.GeocoderLocationType ثابت‌ها
کتابخانه "geocoding"

نوع مکان برگردانده‌شده از زمین‌کدیاب را شرح می‌دهد. این‌ها را براساس مقدار یا بااستفاده از نام ثابت مشخص کنید. برای مثال، 'ROOFTOP' یا google.maps.GeocoderLocationType.ROOFTOP.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع GeocoderLocationTypeString تعریف می‌شوند.

const {GeocoderLocationType} = await google.maps.importLibrary("geocoding");

ثابت‌ها
APPROXIMATE	نتیجه برگردانده‌شده تقریبی است.
GEOMETRIC_CENTER	نتیجه برگردانده‌شده مرکز هندسی نتیجه‌ای مثل خط (مثلاً خیابان) یا چندضلعی (منطقه) است.
RANGE_INTERPOLATED	نتیجه برگردانده‌شده نشان‌دهنده یک تقریب (معمولاً در جاده) است که بین دو نقطه دقیق (مانند تقاطع‌ها) درون‌یابی شده است. نتایج درون‌یابی‌شده معمولاً زمانی برگردانده می‌شوند که زمین‌کدیاب‌های پشت‌بام برای نشانی خیابان دردسترس نباشند.
ROOFTOP	نتیجه برگردانده‌شده نشان‌دهنده زمین‌کدیاب دقیق است.

میانای نشانگر مکانی

میانا google.maps.Landmark

توجه: فقط در کانال v=beta دردسترس است.

مکانی که نشان‌دهنده نقطه مرجع برای نشانی است.

مشخصات
display_name	نوع: string نام مکان دیدنی.
display_name_language_code	نوع: string زبان نام مکان دیدنی.
place_id	نوع: string «شناسه مکان» مؤسسه اصلی که به‌عنوان نشانگر استفاده می‌شود. می‌تواند برای حل‌وفصل اطلاعات بیشتر درباره نشانگر مکانی ازطریق «جزئیات جا» یا «جستجوی شناسه جا» استفاده شود.
spatial_relationship	نوع: SpatialRelationship رابطه فضایی بین مکان هدف و نقطه عطف را تعریف می‌کند.
straight_line_distance_meters	نوع: number فاصله مستقیم بین مکان هدف و نقطه عطف.
types	نوع: Array<string> یک یا چند مقدار که نوع نتیجه برگردانده‌شده را نشان می‌دهد. برای جزئیات بیشتر، لطفاً انواع را ببینید.
travel_distance_meters اختیاری	نوع: number optional مسافت سفر در امتداد شبکه جاده‌ای بین مکان هدف و نقطه عطف. اگر نشانگر از بخشی از شبکه جاده‌ای که هدف به آن نزدیک‌تر است جدا شده باشد، یا اگر مکان هدف درواقع در شبکه جاده‌ای درنظر گرفته نشده باشد، این فیلد می‌تواند خالی باشد.

میانای منطقه

میانا google.maps.Area

توجه: فقط در کانال v=beta دردسترس است.

مکانی که منطقه کوچکی است، مانند محله، حومه، یا مجتمع بزرگی که حاوی مکان هدف است.

مشخصات
containment	نوع: Containment رابطه فضایی بین مکان هدف و منطقه را تعریف می‌کند.
display_name	نوع: string نام منطقه.
display_name_language_code	نوع: string زبان نام منطقه.
place_id	نوع: string «شناسه مکان» منطقه زیرین. می‌تواند برای حل‌وفصل اطلاعات بیشتر درباره منطقه ازطریق «جزئیات جا» یا «جستجوی شناسه جا» استفاده شود.

ثابت‌های مهار

google.maps.Containment ثابت‌ها
کتابخانه "geocoding"

توجه: فقط در کانال v=beta دردسترس است.

یک enum که رابطه فضایی بین منطقه و مکان هدف را نشان می‌دهد.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع ContainmentString تعریف می‌شوند.

const {Containment} = await google.maps.importLibrary("geocoding");

ثابت‌ها
NEAR	مکان هدف خارج از منطقه است، اما نزدیک به آن است.
OUTSKIRTS	مکان هدف در منطقه ناحیه، نزدیک به لبه است.
WITHIN	مکان هدف در منطقه ناحیه، نزدیک به مرکز است.

ثابت‌های SpatialRelationship

google.maps.SpatialRelationship ثابت‌ها
کتابخانه "geocoding"

توجه: فقط در کانال v=beta دردسترس است.

یک enum که نشان‌دهنده رابطه فضایی بین نقطه عطف و هدف است.

این ثابت‌ها به‌عنوان رشته نیز قابل‌استفاده هستند. در TypeScript، رشته‌های لفظی با نوع SpatialRelationshipString تعریف می‌شوند.

const {SpatialRelationship} = await google.maps.importLibrary("geocoding");

ثابت‌ها
ACROSS_THE_ROAD	هدف دقیقاً روبه‌روی نقطه عطف در سمت دیگر جاده است.
AROUND_THE_CORNER	در همان مسیر نشانگر نیست اما با یک پیچ به آن می‌رسید.
BEHIND	نزدیک به ساختار نشانگر مکانی اما دورتر از نقطه دسترسی آن.
BESIDE	هدف مستقیماً در مجاورت نشانگر مکانی است.
DOWN_THE_ROAD	در همان مسیر مکان دیدنی اما نه در کنار یا روبه‌روی آن.
NEAR	این رابطه پیش‌فرض است، اگر هیچ‌یک از موارد خاص‌تر زیر اعمال نشود.
WITHIN	این مکان دیدنی دارای هندسه فضایی است و هدف در محدوده آن قرار دارد.