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)

非推奨です。このフィールドは、すべてのリクエストで無視されます。

小数点以下 9 桁まで、「s」で終わる秒単位の期間（例: "3.5s"）。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

Locations.FindMatchingLocations に対するレスポンス メッセージです。

JSON 表現 
{
  "matchedLocations": [
    {
      object (MatchedLocation)
    }
  ],
  "matchTime": string
}
フィールド
matchedLocations[]

object (MatchedLocation)

指定した場所に一致する可能性がある場所のコレクションです。一致度が高い順に表示されます。完全に一致するものがある場合は、そのページが最初の位置に表示されます。
matchTime

string (Timestamp format)

このビジネスに対して照合アルゴリズムが最後に実行された日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "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

これは完全一致ですか？