本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 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 资源名称 (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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 适用于 Java 的 SDK 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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS Python 软件开发工具包](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)