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.getlocations.batchGet では取得できません)が含まれますが、これらに限定されません。storeCodeserviceArea のサポート エリアの詳細labelsadWordsLocationExtensionsphotos

isExactMatch

boolean

これは完全一致ですか?