Method: brands.agents.list

ブランドに関連付けられているすべてのエージェントを一覧表示します。

HTTP リクエスト

GET https://businesscommunications.googleapis.com/v1/{parent=brands/*}/agents

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

パスパラメータ

パラメータ
parent

string

必須。ブランドの一意の識別子。ブランド ID が「1234」の場合、このパラメータは「brands/1234」に解決されます。RCS for Business キャリアのすべてのエージェントを返すには、ブランド ID を「-」にする必要があります。

クエリ パラメータ

パラメータ
pageSize

integer

サーバーから返される結果の最大数を指定します。サーバーは、1 ページで返される結果の最大数をさらに制限する場合があります。pageSize が 0 の場合、返される結果の数はサーバーが決定します。
pageToken

string

前の List リクエストから返された nextPageToken 値（存在する場合）。
launchStateFilter

enum (LaunchState)

省略可。この起動状態のエージェントのみを返します。キャリアが使用する場合にのみ機能します。
includeLaunchData

boolean

true の場合、起動データ（アンケートなし）がエージェント レスポンスに含まれます。キャリアが使用する場合にのみ機能します。
includeArchived

boolean

省略可。アーカイブされたエージェントをレスポンスに含めます。
includeHidden

boolean

省略可。非表示のエージェントをレスポンスに含めます。
orderBy

string

省略可。結果の並べ替えに使用するフィールドのカンマ区切りのリストを指定します。

サポートされている並べ替えフィールドは次のとおりです。

  • updateTime: 最終更新タイムスタンプで時系列順に並べ替えます。
  • displayName: 人が読める形式のエージェント名でアルファベット順に並べ替えます。
  • agentId: システムによって生成された一意のエージェント ID で並べ替えます。

サフィックス " desc" または " asc" を指定せずに並べ替えフィールドを指定すると、デフォルトで昇順になります。このパラメータを省略すると、結果は agentId の昇順で並べ替えられます。

リクエストの本文

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

レスポンスの本文

エージェントのリスト。

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

JSON 表現 
{
  "agents": [
    {
      object (Agent)
    }
  ],
  "nextPageToken": string
}
フィールド
agents[]

object (Agent)

エージェント情報のリスト。
nextPageToken

string

結果の次のページを取得するためのページ分割トークン。値が "" の場合、リクエストに対する結果はこれ以上ありません。

認可スコープ

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

  • https://www.googleapis.com/auth/businesscommunications

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