فهرستی از نامهای مکان (یا نشانیها) را به نهادهای زمینمکانی خاص (برای نمونه، مکانها) در Google Maps تبدیل میکند.
درخواست HTTP
POST https://mapstools.googleapis.com/v1:resolveNames
نشانی وب از نحو ترانویسی gRPC استفاده میکند.
متن درخواست
بدنه درخواست حاوی دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{ "queries": [ { object ( |
| فیلدها | |
|---|---|
queries[] |
الزامی. فهرستی از پُرسمانهای مکان برای حل شدن. میتوانید حداکثر ۲۰ پُرسمان مشخص کنید. |
locationBias |
اختیاری. منطقهای اختیاری برای گرایش دادن نتایج وضوح. اگر مشخص شده باشد، نتایج وضوح به سمت نهادهایی که به این منطقه نزدیکتر هستند گرایش خواهد داشت. گنجاندن اگر هم |
regionCode |
اختیاری. کد منطقه اختیاری برای گرایش دادن نتایج وضوح. اگر مشخص شده باشد، نتایج وضوح به سمت نهادهایی که در منطقه مشخصشده یا نزدیک آن هستند گرایش خواهد داشت. این باید کد منطقه CLDR باشد. برای مثال، «US» یا «CA». گنجاندن اگر هم |
متن پاسخ
پیام پاسخ برای v1.resolveNames.
درصورت موفقیتآمیز بودن، بدنه پاسخ حاوی دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{ "results": [ { object ( |
| فیلدها | |
|---|---|
results[] |
فقط برونداد. فهرست نهادهای حلوفصلشده از پُرسمانهای مکان. تضمین میشود که با درخواست |
failedRequests |
فقط برونداد. نقشهای که خرابیهای جزئی را نشان میدهد. کلید، شاخص درخواست ناموفق در فیلد شیئی حاوی فهرستی از |
saveToMapsUrl |
فقط برونداد. پیوندی برای ذخیره کردن همه نهادهای باموفقیت حلوفصلشده در Google Maps. |
محدودههای مجوز
به محدوده OAuth زیر نیاز دارد:
https://www.googleapis.com/auth/maps-platform.mapstools
LocationQuery
پُرسمان مکان نشاندهنده نهاد مکان خاصی است که میتواند با Google Maps حلوفصل شود. درحالحاضر، فقط نام مکانها و نشانیها بهعنوان پُرسمانهای مکان پشتیبانی میشود.
| نمایش JSON |
|---|
{ "text": string } |
| فیلدها | |
|---|---|
text |
الزامی. پُرسمان نوشتاری برای تبدیل شدن به نهاد جغرافیایی فضایی خاص در Google Maps، مثل مکان یا نشانی. هرچه پُرسمان دقیقتر باشد، راهحل دقیقتر خواهد بود. برای مثال، «تهران»، «Googleplex, Mountain View, CA»، «1600 Amphitheatre Parkway, Mountain View, CA»، یا «برج ایفل، پاریس». پُرسمانها باید نام مکان یا نشانی خاصی باشد. مکانهای کلی مانند نام زنجیره (مثلاً Starbucks) یا پُرسمان جستجو مانند «رستورانها» پشتیبانی نمیشود. |
LocationBias
منطقهای که نتایج وضوح به آن گرایش دارد.
| نمایش JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"viewport": {
object ( |
| فیلدها | |
|---|---|
| نوع گرایش مکانی. فهرست زیر شامل فیلدهای متقابلاً انحصاری است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد: | |
viewport |
ناحیه نمایشی که با چارگوش محصورکننده تعریف شده است. |
| پایان فیلدهای متقابلاً انحصاری. | |
نتیجه
یک نهاد منفرد حلوفصلشده از یک پُرسمان مکان دادهشده، بههمراه سطح اطمینان حلوفصل.
| نمایش JSON |
|---|
{ "entity": { object ( |
| فیلدها | |
|---|---|
entity |
فقط برونداد. نهاد حلوفصلشده از پُرسمان مکان. |
confidence |
فقط برونداد. سطح اطمینان برای وضوح. |
اطمینان
سطح اطمینان برای وضوح.
| شمارشیها | |
|---|---|
CONFIDENCE_UNSPECIFIED |
مقدار پیشفرض. از این مقدار استفاده نمیشود. |
MEDIUM |
اطمینان متوسط نشان میدهد که وضوح احتمالاً درست است اما ممکن است نامزدهای دیگری هم وجود داشته باشد. |
HIGH |
اطمینان بالا نشان میدهد که وضوح صحیح است و نشاندهنده یک نهاد فضایی-مکانی خاص (مثلاً یک مکان خاص) است. |