尋找與指定地區相符的所有可能地點。地點必須未經驗證,這項操作才有效。
HTTP 要求
POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:findMatches
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
name |
要尋找相符項目的位置資源名稱。 |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 | |
---|---|
{ "languageCode": string, "numResults": integer, "maxCacheDuration": string } |
欄位 | |
---|---|
languageCode |
比對位置的偏好語言 (採用 BCP-47 格式)。 |
numResults |
要傳回的相符項目數量。預設值為 3,最多 10。請注意,如果要求更多,延遲時間可能會增加。沒有分頁。 |
maxCacheDuration |
已淘汰,所有要求都會忽略這個欄位。 時間長度以秒為單位,最多可有 9 個小數位數,並應以「 |
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
Locations.FindMatchingLocations 的回應訊息。
JSON 表示法 | |
---|---|
{
"matchedLocations": [
{
object ( |
欄位 | |
---|---|
matchedLocations[] |
可能與指定地點相符的一組地點,依比對程度由高至低列出。如果有完全相符的項目,會排在第一個位置。 |
matchTime |
上次對這個位置執行比對演算法的時間。 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例: |
授權範圍
需要下列其中一種 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 |
這是完全相符的結果嗎? |