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 の概要をご覧ください。

一致した地域

ビジネスと一致する可能性のあるビジネスを表します。

JSON 表現
{
  "location": {
    object (Location)
  },
  "isExactMatch": boolean
}
フィールド
location

object (Location)

一致がある可能性のある、まばらに入力される場所。入力されないフィールドとしては、名前(一致した場所は locations.getlocations.batchGet では取得できない)、storeCodeserviceArea カバレッジの詳細、labelsadWordsLocationExtensionsphotos などがありますが、これらに限定されません。

isExactMatch

boolean

これは完全一致ですか?