Method: googleLocations.search

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

HTTP リクエスト

POST https://mybusinessbusinessinformation.googleapis.com/v1/googleLocations:search

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

リクエスト本文

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

JSON 表現 
{
  "pageSize": 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.
}
フィールド
pageSize

integer

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

object (Location)

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

string

検索するテキストクエリ。クエリ文字列から得られる検索結果は、正確な場所を指定する場合よりも精度は低くなりますが、完全一致しない一致の可能性は高くなります。

レスポンスの本文

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

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

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

object (GoogleLocation)

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

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、OAuth 2.0 の概要をご覧ください。