Method: resolveNames

فهرستی از نام‌های مکان (یا نشانی‌ها) را به نهادهای جغرافیایی-فضایی خاص (مثلاً مکان‌ها) در Google Maps تبدیل می‌کند.

درخواست HTTP

POST https://mapstools.googleapis.com/v1:resolveNames

نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

متن درخواست

بدنه درخواست حاوی داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "queries": [
    {
      object (LocationQuery)
    }
  ],
  "locationBias": {
    object (LocationBias)
  },
  "regionCode": string
}
فیلدها
queries[]

object (LocationQuery)

الزامی. فهرستی از پرسمان‌های مکان که باید حل شوند. می‌توانید حداکثر ۲۰ پُرسمان مشخص کنید.
locationBias

object (LocationBias)

اختیاری. منطقه‌ای اختیاری برای سوگیری نتایج وضوح. اگر مشخص شود، نتایج وضوح به سمت نهادهایی که به این منطقه نزدیک‌تر هستند سوگیری خواهد داشت. گنجاندن locationBias یا regionCode اغلب با محدود کردن فضای جستجو نتایج بهتری ارائه می‌دهد.

اگر هم locationBias و هم regionCode مشخص شده باشد، locationBias بر regionCode اولویت دارد.
regionCode

string

اختیاری. کد منطقه اختیاری برای سوگیری نتایج وضوح. اگر مشخص شود، نتایج وضوح به سمت نهادهایی که در منطقه مشخص‌شده یا نزدیک آن هستند متمایل خواهد شد. این باید کد منطقه CLDR باشد. برای مثال، «US» یا «CA». گنجاندن locationBias یا regionCode اغلب با محدود کردن فضای جستجو نتایج بهتری ارائه می‌دهد.

اگر هم locationBias و هم regionCode مشخص شده باشد، locationBias بر regionCode اولویت دارد.

بدنه پاسخ

پیام پاسخ برای v1.resolveNames.

درصورت موفقیت‌آمیز بودن، بدنه پاسخ حاوی داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "results": [
    {
      object (Result)
    }
  ],
  "failedRequests": {
    integer: {
      object (Status)
    },
    ...
  },
  "saveToMapsUrl": string
}
فیلدها
results[]

object (Result)

فقط خروجی. فهرست نهادهای حل‌شده از پُرسمان‌های مکان. تضمین می‌شود که با نمایه‌های queries درخواست، نگاشت ۱:۱ داشته باشد. رشته خالی در نمایه i نشان می‌دهد که تفکیک برای آن پُرسمان ناموفق بود. اگر حل‌وفصل ناموفق بود، لطفاً فیلد failedRequests را برای وضعیت خطا بررسی کنید.
failedRequests

map (key: integer, value: object (Status))

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

شیئی که حاوی فهرستی از جفت‌های "key": value است. مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
saveToMapsUrl

string

فقط خروجی. پیوندی برای ذخیره کردن همه نهادهای باموفقیت حل‌شده در Google Maps.

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/maps-platform.mapstools

LocationQuery

پُرسمان مکان نشان‌دهنده نهاد مکان خاصی است که می‌توان آن را با Google Maps حل کرد. درحال‌حاضر، فقط نام‌ها و نشانی‌های مکان به‌عنوان پُرسمان‌های مکان پشتیبانی می‌شوند.

نمایش JSON 
{
  "text": string
}
فیلدها
text

string

الزامی. پُرسمان نوشتاری برای حل کردن یک موجودیت جغرافیایی خاص در Google Maps، مانند یک مکان یا نشانی. هرچه پُرسمان دقیق‌تر باشد، وضوح دقیق‌تر است. برای مثال، «San Francisco»،‏ «Googleplex, Mountain View, CA»،‏ «1600 Amphitheatre Parkway, Mountain View, CA»، یا «Eiffel Tower, Paris». پرس‌وجوها باید نشانی یا نام مکان خاصی باشد. مکان‌های کلی مانند نام زنجیره (مثلاً 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)
  }
  // End of mutually exclusive fields.
}
فیلدها
نوع سوگیری مکان. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
viewport

object (Viewport)

ناحیه نمایشی که با چارگوش محصورکننده تعریف شده است.
پایان فیلدهای متقابلاً انحصاری.

نتیجه

یک موجودیت حل‌شده از پُرسمان مکان داده‌شده، به‌همراه سطح اطمینان حل‌وفصل.

نمایش JSON 
{
  "entity": {
    object (Entity)
  },
  "confidence": enum (Confidence)
}
فیلدها
entity

object (Entity)

فقط خروجی. نهاد حل‌شده از پُرسمان مکان.
confidence

enum (Confidence)

فقط خروجی. سطح اطمینان برای وضوح.

اطمینان

سطح اطمینان برای وضوح.

شمارشی‌ها
CONFIDENCE_UNSPECIFIED مقدار پیش‌فرض. از این مقدار استفاده نشده است.
MEDIUM اطمینان متوسط نشان می‌دهد که وضوح احتمالاً درست است اما ممکن است گزینه‌های دیگری نیز وجود داشته باشد.
HIGH اطمینان بالا نشان می‌دهد که وضوح صحیح است و نشان‌دهنده یک نهاد جغرافیایی خاص (مثلاً یک مکان خاص) است.