- درخواست HTTP
- درخواست بدنه
- بدنه پاسخ
- دامنههای مجوز
- جستجوی موقعیت مکانی
- موقعیت مکانی
- ویوپورت
- لاتلنگ
- نتیجه
- اعتماد به نفس
فهرستی از نام مکانها (یا آدرسها) را به موجودیتهای جغرافیایی خاص (مثلاً مکانها) در نقشههای گوگل تبدیل میکند.
درخواست HTTP
POST https://mapstools.googleapis.com/v1alpha:resolveNames
این URL از سینتکس Transcoding در gRPC استفاده میکند.
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{ "queries": [ { object ( |
| فیلدها | |
|---|---|
queries[] | الزامی. فهرستی از درخواستهای مکانی که باید حل شوند. میتوانید تا ۲۰ درخواست را مشخص کنید. |
locationBias | اختیاری. یک ناحیه اختیاری برای سوگیری نتایج تفکیک. در صورت مشخص شدن، نتایج تفکیک به سمت موجودیتهایی که به این ناحیه نزدیکتر هستند، سوگیری خواهد داشت. گنجاندن اگر هر دو |
regionCode | اختیاری. یک کد منطقه اختیاری برای سوگیری نتایج تفکیک. در صورت مشخص شدن، نتایج تفکیک به سمت موجودیتهایی که در منطقه مشخص شده یا نزدیک آن هستند، سوگیری خواهد شد. این باید یک کد منطقه CLDR باشد. به عنوان مثال، "US" یا "CA". گنجاندن اگر هر دو |
بدنه پاسخ
پیام پاسخ برای v1alpha.resolveNames.
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{ "results": [ { object ( |
| فیلدها | |
|---|---|
results[] | فقط خروجی. فهرست موجودیتهای حلشده از کوئریهای مکان. تضمین میشود که با اندیسهای |
failedRequests | فقط خروجی. نقشهای که شکستهای جزئی را گزارش میدهد. کلید، اندیس درخواست شکستخورده در فیلد یک شیء شامل لیستی از جفتهای |
دامنههای مجوز
به یکی از حوزههای OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/maps-platform.mapstools -
https://www.googleapis.com/auth/cloud-platform.read-only
جستجوی موقعیت مکانی
یک جستجوی مکان، یک موجودیت مکانی خاص را نشان میدهد که میتواند با نقشههای گوگل حل شود. در حال حاضر، فقط نام مکانها و آدرسها به عنوان جستجوی مکان پشتیبانی میشوند.
| نمایش JSON |
|---|
{ "text": string } |
| فیلدها | |
|---|---|
text | الزامی. عبارت جستجوی متنی برای رسیدن به یک موجودیت مکانی خاص در نقشههای گوگل، مانند یک مکان یا یک آدرس. هرچه عبارت جستجو خاصتر باشد، وضوح آن دقیقتر است. برای مثال، "سانفرانسیسکو"، "گوگلپلکس، مانتین ویو، کالیفرنیا"، "1600 آمفیتئاتر پارکوی، مانتین ویو، کالیفرنیا" یا "برج ایفل، پاریس". عبارتهای جستجو باید شامل یک آدرس یا نام مکان خاص باشند. مکانهای عمومی مانند نام یک فروشگاه زنجیرهای (مثلاً استارباکس) یا عبارت جستجویی مانند "رستورانها" پشتیبانی نمیشوند. |
موقعیت مکانی
منطقه ای که نتایج تفکیک پذیری را تحت تأثیر قرار می دهد.
| نمایش JSON |
|---|
{ // Union field |
| فیلدها | |
|---|---|
type فیلد Union. نوع بایاس مکانی. type میتواند فقط یکی از موارد زیر باشد: | |
viewport | یک دریچه دید که توسط یک کادر محصورکننده تعریف میشود. |
ویوپورت
یک دریچه دید طول و عرض جغرافیایی، که به صورت دو نقطه low و high که به صورت مورب روبروی هم قرار دارند، نمایش داده میشود. یک دریچه دید یک منطقه بسته در نظر گرفته میشود، یعنی شامل مرز خود است. محدودههای عرض جغرافیایی باید بین ۹۰- تا ۹۰ درجه و محدودههای طول جغرافیایی باید بین ۱۸۰- تا ۱۸۰ درجه باشند. موارد مختلف عبارتند از:
اگر
low=high، نمای دید از آن نقطه واحد تشکیل شده است.اگر
low.longitude>high.longitude، محدوده طول جغرافیایی معکوس میشود (صفحه نمایش از خط طول جغرافیایی ۱۸۰ درجه عبور میکند).اگر
low.longitude= -180 درجه وhigh.longitude= 180 درجه باشد، صفحه نمایش شامل تمام طولهای جغرافیایی میشود.اگر
low.longitude= 180 درجه وhigh.longitude= -180 درجه باشد، محدوده طول جغرافیایی خالی است.اگر
low.latitude>high.latitude، محدوده عرض جغرافیایی خالی است.
هر دو پارامتر low و high باید پر شوند و کادر نمایش داده شده نمیتواند خالی باشد (همانطور که در تعاریف بالا مشخص شده است). یک viewport خالی منجر به خطا خواهد شد.
برای مثال، این نمای کلی، شهر نیویورک را به طور کامل در بر میگیرد:
{ "کم": { "عرض جغرافیایی": ۴۰.۴۷۷۳۹۸، "طول جغرافیایی": -۷۴.۲۵۹۰۸۷ }، "زیاد": { "عرض جغرافیایی": ۴۰.۹۱۶۱۸، "طول جغرافیایی": -۷۳.۷۰۰۱۸ } }
| نمایش JSON |
|---|
{ "low": { object ( |
| فیلدها | |
|---|---|
low | الزامی. نقطه پایین دید. |
high | الزامی. نقطه اوج منظره. |
لاتلنگ
شیءای که یک جفت عرض/طول جغرافیایی را نشان میدهد. این به صورت یک جفت دوتایی بیان میشود تا درجه عرض جغرافیایی و درجه طول جغرافیایی را نشان دهد. مگر اینکه خلاف آن مشخص شده باشد، این شیء باید با استاندارد WGS84 مطابقت داشته باشد. مقادیر باید در محدوده نرمال باشند.
| نمایش JSON |
|---|
{ "latitude": number, "longitude": number } |
| فیلدها | |
|---|---|
latitude | عرض جغرافیایی بر حسب درجه. باید در محدوده [-90.0، +90.0] باشد. |
longitude | طول جغرافیایی بر حسب درجه. باید در محدوده [-۱۸۰.۰، +۱۸۰.۰] باشد. |
نتیجه
یک موجودیت حلشده از یک پرسوجوی موقعیت مکانی مشخص، به همراه سطح اطمینان حل آن.
| نمایش JSON |
|---|
{ "entity": { object ( |
| فیلدها | |
|---|---|
entity | فقط خروجی. موجودیت حل شده از جستجوی مکان. |
confidence | فقط خروجی. سطح اطمینان برای حل. |
اعتماد به نفس
سطح اطمینان برای قطعنامه.
| انومها | |
|---|---|
CONFIDENCE_UNSPECIFIED | مقدار پیشفرض. این مقدار استفاده نشده است. |
MEDIUM | اطمینان متوسط نشان میدهد که این راهحل احتمالاً درست است، اما ممکن است گزینههای دیگری نیز وجود داشته باشد. |
HIGH | اطمینان بالا نشان میدهد که تفکیکپذیری صحیح است و یک موجودیت جغرافیایی-مکانی خاص (مثلاً یک مکان خاص) را نشان میدهد. |