Method: googleLocations.search

指定したリクエストに一致する可能性のあるすべてのビジネスを検索します。

HTTP リクエスト

POST https://mybusiness.googleapis.com/v4/googleLocations:search

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "resultCount": integer,

  // Union field search_query can be only one of the following:
  "location": {
    object (Location)
  },
  "query": string
  // End of list of possible types for union field search_query.
}
フィールド
resultCount

integer

返される一致の数です。デフォルト値は 3 で、最大値は 10 です。リクエストされる回数が多いと、レイテンシが増加する可能性があるので注意してください。ページ分けはありません。
共用体フィールド search_query。検索語句。これは、location オブジェクトまたは文字列クエリとして指定できます。search_query は次のいずれかになります。
location

object (Location)

検索する場所。指定すると、指定した場所の詳細に一致する場所が検出されます。
query

string

検索するテキストクエリ。クエリ文字列による検索結果は、正確な位置情報を指定した場合よりも精度は落ちますが、完全一致しないケースは多くなります。

レスポンスの本文

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

JSON 表現 
{
  "googleLocations": [
    {
      object (GoogleLocation)
    }
  ]
}
フィールド
googleLocations[]

object (GoogleLocation)

指定されたリクエストと一致する可能性のある GoogleLocations のコレクション。精度の高い順に一覧表示されます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

詳しくは、OAuth 2.0 の概要をご覧ください。