Method: chains.search

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

HTTP リクエスト

GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/chains:search

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

クエリ パラメータ

パラメータ
chainName

string

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

pageSize

integer

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

リクエストの本文

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

レスポンスの本文

Locations.SearchChains のレスポンス メッセージ。

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

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

object (Chain)

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

認可スコープ

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

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

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