調用 ListCustomAudience API 擷取受眾資料 - Message Service ChatApp

自訂受眾列表查詢。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cams:ListCustomAudience

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
CustSpaceId	string	是	ISV 子客戶的 SpaceId/執行個體 ID。即通道 ID，在通道管理介面查看。	cams-**
PageId	string	是	Messenger 的 PageId	3939**
AdAccountId	string	否	Meta 廣告賬戶 ID	339**
TokenType	string	否	Token 類型。	custom
CustomAudienceName	string	否	自訂受眾名稱	name
Page	object	是	分頁資訊。
Size	integer	是	每頁顯示數量。	95
Index	integer	是	頁數。	40
CustomAudienceId	string	否	自訂受眾 ID	239**

返回參數

名稱	類型	描述	樣本值
	object
AccessDeniedDetail	string	訪問被拒絕詳細資料。	None
Message	string	錯誤描述資訊。	OK
RequestId	string	請求 ID。	39**
Total	integer	總記錄條數。	69
Data	array<object>	返回資料。
	object	返回資料。
PageId	string	Messenger 的 PageId	239**
Status	string	狀態	None
CustomAudienceId	string	自訂受眾 ID	339**
CustomAudienceName	string	自訂受眾名稱	custom audience name
TokenType	string	Token 類型。	custom
Description	string	描述。	desc
CreateTime	integer	建立時間	1720356898
AdAccountId	string	Meta 廣告賬戶 ID	339**
UpdateTime	integer	更新時間	51
TokenTotal	integer	token 數量	70
UploadType	string	使用者上傳類型	excel
Code	string	請求狀態代碼。返回 OK 代表請求成功。其他錯誤碼，請參見錯誤碼列表。	OK
Success	boolean	是否調用成功。 true：調用成功。 false：調用失敗。	true

樣本

正常返回樣本

JSON格式

{
  "AccessDeniedDetail": "None",
  "Message": "OK",
  "RequestId": "39**",
  "Total": 69,
  "Data": [
    {
      "PageId": "239**",
      "Status": "None",
      "CustomAudienceId": "339**",
      "CustomAudienceName": "custom audience name",
      "TokenType": "custom",
      "Description": "desc",
      "CreateTime": 1720356898,
      "AdAccountId": "339**",
      "UpdateTime": 51,
      "TokenTotal": 70,
      "UploadType": "excel"
    }
  ],
  "Code": "OK",
  "Success": true
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。