Method: brands.agents.list

列出與品牌相關聯的所有代理人。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必填。品牌的專屬 ID。如果品牌 ID 為「1234」，這個參數會解析為「brands/1234」。如要傳回 RCS for Business 電信業者的所有代理程式，品牌 ID 必須為「-」。

查詢參數

參數
pageSize

integer

指定伺服器傳回的結果數量上限。伺服器可能會進一步限制單一頁面中傳回的結果數量上限。如果 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。