Method: accounts.locations.findMatches

همه مکان های ممکن را که با مکان مشخص شده مطابقت دارند را پیدا می کند. این عملیات تنها در صورتی معتبر است که مکان تأیید نشده باشد.

درخواست HTTP

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:findMatches

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
name

string

نام منبع مکان برای یافتن موارد منطبق برای.

درخواست بدن

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

نمایندگی JSON 
{
  "languageCode": string,
  "numResults": integer,
  "maxCacheDuration": string
}
فیلدها
languageCode

string

زبان ترجیحی برای مکان منطبق (در قالب BCP-47).

numResults

integer

تعداد مسابقات برای بازگشت. مقدار پیش‌فرض 3 و حداکثر 10 است. توجه داشته باشید که در صورت درخواست بیشتر، تاخیر ممکن است افزایش یابد. صفحه بندی وجود ندارد.

maxCacheDuration

string ( Duration format)

منسوخ شده است. این فیلد برای همه درخواست ها نادیده گرفته می شود.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' خاتمه می یابد. مثال: "3.5s" .

بدن پاسخگو

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

پیام پاسخ برای Locations.FindMatchingLocations.

نمایندگی JSON 
{
  "matchedLocations": [
    {
      object (MatchedLocation)
    }
  ],
  "matchTime": string
}
فیلدها
matchedLocations[]

object ( MatchedLocation )

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

matchTime

string ( Timestamp format)

آخرین باری که الگوریتم تطبیق برای این مکان اجرا شد.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

محدوده مجوز

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

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

MatchedLocation

نشان دهنده تطابق احتمالی با یک مکان است.

نمایندگی JSON 
{
  "location": {
    object (Location)
  },
  "isExactMatch": boolean
}
فیلدها
location

object ( Location )

مکان کم جمعیتی که بالقوه مطابقت دارد. فیلدهای خالی شامل، اما ممکن است محدود به این نباشد: نام (مکان مطابقت داده شده را نمی توان از طریق locations.get یا locations.batchGet بازیابی کرد). storeCode ; جزئیات منطقه پوشش serviceArea ؛ labels ؛ adWordsLocationExtensions ; photos

isExactMatch

boolean

آیا این یک تطابق دقیق است؟