ListCampaigns - Amazon Personalize

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

ListCampaigns

傳回使用指定解決方案的促銷活動清單。如果未指定解決方案,則會列出與該帳戶相關聯的所有廣告活動。回應會為每個廣告活動提供屬性,包括 Amazon 資源名稱 (ARN)。如需促銷活動的詳細資訊,請參閱CreateCampaign

請求語法

{ "maxResults": number, "nextToken": "string", "solutionArn": "string" }

請求參數

請求接受採用 JSON 格式的下列資料。

maxResults

要傳回的行銷活動數目上限。

類型:整數

有效範圍:最小值為 1。最大值為 100。

必要:否

nextToken

從上一次呼叫傳回的 Token,以ListCampaigns取得下一組行銷活動 (如果有的話)。

類型:字串

長度限制:最大長度為 1500。

模式:\p{ASCII}{0,1500}

必要:否

solutionArn

用於列出行銷活動的解決方案的 Amazon 資源名稱 (ARN)。如果未指定解決方案,則會列出與該帳戶相關聯的所有廣告活動。

類型:字串

長度限制:長度上限為 256。

模式:arn:([a-z\d-]+):personalize:.*:.*:.+

必要:否

回應語法

{ "campaigns": [ { "campaignArn": "string", "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "name": "string", "status": "string" } ], "nextToken": "string" }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

campaigns

行銷活動的清單。

類型:CampaignSummary 物件陣列

陣列成員:最多 100 個項目。

nextToken

用於獲取下一組廣告系列的令牌(如果存在)。

類型:字串

長度限制:最大長度為 1500。

模式:\p{ASCII}{0,1500}

錯誤

InvalidInputException

提供欄位或參數的有效值。

HTTP 狀態碼:400

InvalidNextTokenException

令牌無效。

HTTP 狀態碼:400

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: