CreateCampaign - Amazon Personalize

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

CreateCampaign

重要

活動有效時,您會產生廣告活動費用。為避免不必要的費用,請確保在完成後刪除廣告系列。如需宣傳活動費用的相關資訊,請參閱 Amazon Personalize 定價

建立部署解決方案版本的促銷活動。當用戶端呼叫GetRecommendationsGetPersonalizedRankingAPI 時,會在要求中指定促銷活動。

最低佈建 TPS 和自動調整規模

重要

minProvisionedTPS會增加您的成本。我們建議從 1 開始 minProvisionedTPS (預設值)。使用 Amazon CloudWatch 指標追蹤您的使用情況,並minProvisionedTPS視需要增加使用量。

建立 Amazon 個人化行銷活動時,您可以指定行銷活動每秒佈建的最低交易 (minProvisionedTPS)。這是 Amazon Personalize 佈建之促銷活動的基準交易輸送量。它設置了活動活動時的最低帳單費用。事務是單個GetRecommendationsGetPersonalizedRanking請求。預設值minProvisionedTPS為 1。

如果您的 TPS 增加到超出的範圍minProvisionedTPS,Amazon Personalize 會自動擴展佈建的容量,但永遠不會降低佈建的容量。minProvisionedTPS容量增加時會有很短的時間延遲,這可能會導致交易損失。當您的流量減少時,容量會回到minProvisionedTPS.

您需支付佈建的最低 TPS 費用,或者,如果您的請求超過實際 TPS 的費用。minProvisionedTPS實際的 TPS 是您提出的建議要求總數。我們建議從低位開始minProvisionedTPS,使用 Amazon CloudWatch 指標追蹤您的使用情況,然後minProvisionedTPS視需要增加使用量。

如需宣傳活動成本的詳細資訊,請參閱 Amazon Personalize 定價

狀態

行銷活動可以處於下列其中一種狀態:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

若要取得廣告活動狀態,請撥打電話DescribeCampaign

注意

等到廣告系列status的是,ACTIVE然後向廣告系列提出建議。

請求語法

{ "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "syncWithLatestSolutionVersion": boolean }, "minProvisionedTPS": number, "name": "string", "solutionVersionArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] }

請求參數

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

campaignConfig

廣告活動的設定詳細資料。

類型:CampaignConfig 物件

必要:否

minProvisionedTPS

指定 Amazon Personalize 將支援的每秒要求最低佈建交易 (建議)。高minProvisionedTPS將增加您的賬單。我們建議從 1 開始 minProvisionedTPS (預設值)。使用 Amazon CloudWatch 指標追蹤您的使用情況,並minProvisionedTPS視需要增加使用量。

類型:整數

有效範圍:最小值為 1。

必要:否

name

新行銷活動的名稱。廣告活動名稱在您的帳戶中必須是唯一的。

類型:字串

長度限制:長度下限為 1。長度上限為 63。

模式:^[a-zA-Z0-9][a-zA-Z0-9\-_]*

必要:是

solutionVersionArn

要與促銷活動一起部署的訓練模型的 Amazon 資源名稱 (ARN)。若要指定解決方案的最新解決方案版本,請以SolutionArn/$LATEST格式指定方案的 ARN。如果True在中syncWithLatestSolutionVersion將設定為,則必須使用此格式CampaignConfig

若要部署不是解決方案最新解決方案版本的模型,請指定解決方案版本的 ARN。

如需自動更新廣告活動的詳細資訊,請參閱啟用自動廣告活動更新

類型:字串

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

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

必要:是

tags

要套用至行銷活動的標籤清單。

類型:Tag 物件陣列

陣列成員:項目數下限為 0。項目數上限為 200。

必要:否

回應語法

{ "campaignArn": "string" }

回應元素

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

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

campaignArn

行銷活動的 Amazon Resource Name (ARN)。

類型:字串

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

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

錯誤

InvalidInputException

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

HTTP 狀態碼:400

LimitExceededException

已超過每秒要求數目的限制。

HTTP 狀態碼:400

ResourceAlreadyExistsException

指定的資源已存在。

HTTP 狀態碼:400

ResourceInUseException

指定的資源正在使用中。

HTTP 狀態碼:400

ResourceNotFoundException

找不到指定的資源。

HTTP 狀態碼:400

TooManyTagsException

您已超過可套用至此資源的標籤數目上限。

HTTP 狀態碼:400

另請參閱

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