Method: chains.search

チェーン名に基づいてチェーンを検索します。

HTTP リクエスト

GET https://mybusiness.googleapis.com/v4/chains:search

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

クエリ パラメータ

パラメータ
chainDisplayName

string

チェーン名でチェーンを検索します。完全一致クエリ、部分クエリ、ファジークエリ、関連クエリがサポートされています。例: 「walmart」、「wal-mart」、「walmmmart」、「ウォ尔玛」
resultCount

integer

このクエリから返される一致チェーンの最大数。デフォルト値は 10 です。指定できる最大値は 500 です。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

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

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

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

object (Chain)

SearchChainsRequest でクエリされた chainDisplayName に一致するチェーン。一致するものがない場合、このフィールドは空になります。検索結果は関連性の高い順に表示されます。

認可スコープ

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

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

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