Method: accounts.locations.findMatches

查找与指定位置匹配的所有可能的位置。仅当营业地点未通过验证时,此操作才有效。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
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)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"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.getlocations.batchGet 检索匹配的地理位置);storeCodeserviceArea 覆盖范围详细信息;labelsadWordsLocationExtensionsphotos

isExactMatch

boolean

这是一个完全匹配吗?