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

# GetPersonalizedRanking
<a name="API_RS_GetPersonalizedRanking"></a>

重新排序給定使用者的建議項目清單。清單中的第一個項目視為使用者最可能感興趣的項目。

**注意**  
您必須已使用類型為 PERSONALIZED\_RANKING 的配方，建立支持行銷活動的解決方案。

## 請求語法
<a name="API_RS_GetPersonalizedRanking_RequestSyntax"></a>

```
POST /personalize-ranking HTTP/1.1
Content-type: application/json

{
   "campaignArn": "{{string}}",
   "context": { 
      "{{string}}" : "{{string}}" 
   },
   "filterArn": "{{string}}",
   "filterValues": { 
      "{{string}}" : "{{string}}" 
   },
   "inputList": [ "{{string}}" ],
   "metadataColumns": { 
      "{{string}}" : [ "{{string}}" ]
   },
   "userId": "{{string}}"
}
```

## URI 請求參數
<a name="API_RS_GetPersonalizedRanking_RequestParameters"></a>

請求不會使用任何 URI 參數。

## 請求主體
<a name="API_RS_GetPersonalizedRanking_RequestBody"></a>

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

 ** [campaignArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-campaignArn"></a>
用於產生個人化排名之行銷活動的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必要：是

 ** [context](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-context"></a>
取得建議時要使用的內容中繼資料。內容中繼資料包括在取得使用者建議時可能相關的任何互動資訊，例如使用者的目前位置或裝置類型。  
類型：字串到字串映射  
映射項目：最多 150 個項目。  
金鑰長度限制：長度上限為 150。  
金鑰模式：`[A-Za-z\d_]+`  
值長度限制：長度上限為 1000。  
必要：否

 ** [filterArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterArn"></a>
您建立的篩選條件的 Amazon Resource Name (ARN)，以包含項目或從給定使用者的建議中排除項目。如需詳細資訊，請參閱[篩選建議](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必要：否

 ** [filterValues](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterValues"></a>
篩選建議時要使用的值。針對篩選條件表達式中的每個預留位置參數，提供參數名稱 （在相符的情況下） 做為索引鍵，並提供篩選條件值 （做為對應值）。以逗號分隔一個參數的多個值。  
對於使用 `INCLUDE`元素包含項目的篩選條件表達式，您必須為表達式中定義的所有參數提供值。對於具有使用 `EXCLUDE`元素排除項目之表達式的篩選條件，您可以省略 `filter-values`。在此情況下，Amazon Personalize 不會使用該表達式的該部分篩選建議。  
如需詳細資訊，請參閱[篩選建議](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)。  
類型：字串到字串映射  
映射項目：最多 25 個項目。  
金鑰長度限制：長度上限為 50。  
金鑰模式：`[A-Za-z0-9_]+`  
值長度限制：長度上限為 1000。  
必要：否

 ** [inputList](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-inputList"></a>
要排名的項目清單 （依 `itemId`)。如果訓練資料集未包含項目，則該項目會附加到重新排名清單的結尾。如果您在建議中包含中繼資料，則上限為 50。否則，上限為 500。  
類型：字串陣列  
長度限制：長度上限為 256。  
必要：是

 ** [metadataColumns](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-metadataColumns"></a>
如果您在建立或更新行銷活動時已在建議中啟用中繼資料，請從項目資料集指定要包含在個人化排名中的中繼資料資料欄。映射索引鍵為 `ITEMS`，值是來自您的項目資料集的資料欄名稱清單。您可以提供的欄數上限為 10。  
 如需啟用行銷活動中繼資料的詳細資訊，請參閱[在行銷活動的建議中啟用中繼資料](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata)。  
類型：字串到字串陣列映射  
映射項目：最多 1 個項目。  
金鑰長度限制：長度上限為 256。  
陣列成員：最多 99 個項目。  
長度限制：長度上限為 150。  
必要：否

 ** [userId](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-userId"></a>
您希望行銷活動為其提供個人化排名的使用者。  
類型：字串  
長度限制：長度上限為 256。  
必要：是

## 回應語法
<a name="API_RS_GetPersonalizedRanking_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "personalizedRanking": [ 
      { 
         "itemId": "string",
         "metadata": { 
            "string" : "string" 
         },
         "promotionName": "string",
         "reason": [ "string" ],
         "score": number
      }
   ],
   "recommendationId": "string"
}
```

## 回應元素
<a name="API_RS_GetPersonalizedRanking_ResponseElements"></a>

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

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

 ** [personalizedRanking](#API_RS_GetPersonalizedRanking_ResponseSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-response-personalizedRanking"></a>
使用者最可能感興趣的項目清單。上限為 500。  
類型：[PredictedItem](API_RS_PredictedItem.md) 物件陣列

 ** [recommendationId](#API_RS_GetPersonalizedRanking_ResponseSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-response-recommendationId"></a>
建議的 ID。  
類型：字串

## 錯誤
<a name="API_RS_GetPersonalizedRanking_Errors"></a>

 ** InvalidInputException **   
提供欄位或參數的有效值。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
指定的資源不存在。  
HTTP 狀態碼：404

## 另請參閱
<a name="API_RS_GetPersonalizedRanking_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 C\+\+ 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetPersonalizedRanking)