Method: googleLocations.search

指定されたリクエストに一致する可能性のあるすべての場所を検索します。

HTTP リクエスト

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

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

リクエストの本文

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

JSON 表現 
{
  "pageSize": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "location": {
    object (Location)
  },
  "query": string
  // End of mutually exclusive fields.
}
フィールド
pageSize

integer

返す一致の数。デフォルト値は 3、最大値は 10 です。リクエスト数が多いと、レイテンシが増加する可能性があります。ページ分けはありません。
検索クエリ。これは、位置情報オブジェクトまたは文字列クエリとして指定できます。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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 Overview をご覧ください。