기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

# GetRecommendations
<a name="API_RS_GetRecommendations"></a>

추천 항목의 목록을 반환합니다. 캠페인의 경우 캠페인의 Amazon 리소스 이름(ARN)이 필요하며 필요한 사용자 및 항목 입력은 다음과 같이 캠페인을 지원하는 솔루션을 생성하는 데 사용된 레시피 유형에 따라 달라집니다.
+ USER\_PERSONALIZATION - `userId`필요, `itemId`는 사용되지 않음
+ RELATED\_ITEMS - `itemId`필요, `userId`는 사용되지 않음

**참고**  
PERSONALIZED\_RANKING 유형의 레시피를 사용하여 만든 솔루션으로 지원되는 캠페인은 [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md)API를 사용합니다.

 추천자의 경우 추천자의 ARN이 필요하며 필요한 항목과 사용자 입력은 해당 추천자를 지원하는 사용 사례(도메인 기반 레시피)에 따라 달라집니다. 사용 사례 요구 사항에 대한 자세한 내용은 [추천자 사용 사례 선택](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html) 단원을 참조하세요.

## Request Syntax
<a name="API_RS_GetRecommendations_RequestSyntax"></a>

```
POST /recommendations HTTP/1.1
Content-type: application/json

{
   "campaignArn": "{{string}}",
   "context": { 
      "{{string}}" : "{{string}}" 
   },
   "filterArn": "{{string}}",
   "filterValues": { 
      "{{string}}" : "{{string}}" 
   },
   "itemId": "{{string}}",
   "metadataColumns": { 
      "{{string}}" : [ "{{string}}" ]
   },
   "numResults": {{number}},
   "promotions": [ 
      { 
         "filterArn": "{{string}}",
         "filterValues": { 
            "{{string}}" : "{{string}}" 
         },
         "name": "{{string}}",
         "percentPromotedItems": {{number}}
      }
   ],
   "recommenderArn": "{{string}}",
   "userId": "{{string}}"
}
```

## URI 요청 파라미터
<a name="API_RS_GetRecommendations_RequestParameters"></a>

요청은 URI 파라미터를 사용하지 않습니다.

## 요청 본문
<a name="API_RS_GetRecommendations_RequestBody"></a>

요청은 JSON 형식으로 다음 데이터를 받습니다.

 ** [campaignArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-campaignArn"></a>
추천을 받기 위해 사용할 캠페인의 Amazon 리소스 이름(ARN)입니다.  
유형: 문자열  
길이 제약: 최대 길이 256.  
패턴: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
필수 여부: 아니요

 ** [context](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-context"></a>
추천을 받을 때 사용할 컨텍스트 메타데이터. 컨텍스트 메타데이터에는 사용자의 현재 위치 또는 기기 유형과 같이 사용자의 추천을 받을 때 관련이 있을 수 있는 모든 상호작용 정보가 포함됩니다.  
유형: 문자열-문자열 맵  
맵 항목: 최대 항목 수 150개.  
키 길이 제약: 최대 길이 150.  
키 패턴: `[A-Za-z\d_]+`   
값 길이 제약: 최대 길이 1000.  
필수 여부: 아니요

 ** [filterArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterArn"></a>
반환되는 추천에 적용할 필터의 ARN입니다. 자세한 내용은 [추천 필터링](https://docs.aws.amazon.com/personalize/latest/dg/filter.html) 단원을 참조하세요.  
이 파라미터를 사용할 때는 필터 리소스가 `ACTIVE`이 맞는지 확인합니다.  
유형: 문자열  
길이 제약: 최대 길이 256.  
패턴: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
필수 여부: 아니요

 ** [filterValues](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterValues"></a>
추천을 필터링할 때 사용할 값. 필터 표현식의 각 자리 표시자 파라미터에 대해 파라미터 이름(대/소문자 구분)을 키로 그리고 필터 값을 해당 값으로 각각 제공합니다. 한 파라미터의 여러 값을 쉼표로 구분합니다.  
`INCLUDE` 요소를 사용하여 항목을 포함시키는 필터 표현식의 경우 표현식에 정의되어 있는 모든 파라미터의 값을 제공해야 합니다. `EXCLUDE` 요소를 사용하여 항목을 제외시키는 표현식이 있는 필터의 경우 `filter-values`를 생략할 수 있습니다. 이 경우 Personalize는 표현식의 해당 부분을 사용하여 추천을 필터링하지 않습니다.  
자세한 내용은 [추천 및 사용자 세그먼트 필터링](https://docs.aws.amazon.com/personalize/latest/dg/filter.html) 단원을 참조하세요.  
유형: 문자열 간 맵  
맵 항목: 최대 항목 수 25개.  
키 길이 제약: 최대 길이 50.  
키 패턴: `[A-Za-z0-9_]+`   
값 길이 제약: 최대 길이 1000.  
필수 여부: 아니요

 ** [itemId](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-itemId"></a>
추천을 제공할 항목 ID.  
`RELATED_ITEMS` 레시피 유형의 경우 필수.  
유형: 문자열  
길이 제약: 최대 길이 256.  
필수 여부: 아니요

 ** [metadataColumns](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-metadataColumns"></a>
캠페인 또는 추천자를 만들거나 업데이트할 때 추천에서 메타데이터를 활성화한 경우 항목 데이터 세트의 메타데이터 열을 지정하여 항목 추천에 포함하세요. 맵 키는 `ITEMS`이고, 값은 항목 데이터 세트의 열 이름 목록입니다. 제공할 수 있는 최대 열 수는 10개입니다.  
 캠페인용 메타데이터 활성화에 대한 자세한 내용은 [캠페인용 추천의 메타데이터 활성화](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata)를 참조하세요. 추천자용 메타데이터 활성화에 대한 자세한 내용은 [추천자용 추천의 메타데이터 활성화](https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata)를 참조하세요.  
유형: 문자열-문자열 어레이 맵  
맵 항목: 최대 항목 수 1개입니다.  
키 길이 제약: 최대 길이 256.  
배열 멤버: 최대 항목 수는 99개입니다.  
길이 제약: 최대 길이 150.  
필수 여부: 아니요

 ** [numResults](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-numResults"></a>
반환할 결과 수. 기본값은 25입니다. 추천에 메타데이터를 포함하는 경우 최대값은 50입니다. 포함하지 않는 경우 최대값은 500입니다.  
유형: 정수  
유효 범위: 최소값 0.  
필수 여부: 아니요

 ** [promotions](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-promotions"></a>
추천 요청에 적용할 프로모션. 홍보는 추천 항목의 구성 가능한 하위 집합에 적용되는 추가 비즈니스 규칙을 정의합니다.  
유형: [Promotion](API_RS_Promotion.md)객체 어레이  
어레이 멤버: 최대 항목 수 1개.  
필수 여부: 아니요

 ** [recommenderArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-recommenderArn"></a>
추천을 받는 데 사용할 추천자의 Amazon 리소스 이름(ARN)입니다. 도메인 사용 사례에 대한 추천자를 사용하여 도메인 데이터세트 그룹을 생성한 경우 추천자 ARN을 제공합니다.  
유형: 문자열  
길이 제약: 최대 길이 256.  
패턴: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
필수 여부: 아니요

 ** [userId](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-userId"></a>
추천을 제공할 사용자 ID.  
`USER_PERSONALIZATION` 레시피 유형의 경우 필수.  
유형: 문자열  
길이 제약: 최대 길이 256.  
필수 여부: 아니요

## 응답 구문
<a name="API_RS_GetRecommendations_ResponseSyntax"></a>

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

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

## 응답 요소
<a name="API_RS_GetRecommendations_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [itemList](#API_RS_GetRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetRecommendations-response-itemList"></a>
예측 점수를 기준으로 내림차순으로 정렬된 추천 목록입니다. 목록에는 최대 500개의 항목이 있을 수 있습니다.  
유형: [PredictedItem](API_RS_PredictedItem.md)객체 어레이

 ** [recommendationId](#API_RS_GetRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetRecommendations-response-recommendationId"></a>
추천의 ID.  
유형: 문자열

## 오류
<a name="API_RS_GetRecommendations_Errors"></a>

 ** InvalidInputException **   
필드 또는 파라미터에 유효한 값을 제공합니다.  
HTTP 상태 코드: 400

 ** ResourceNotFoundException **   
지정한 리소스가 존재하지 않습니다.  
HTTP 상태 코드: 404

## 참고
<a name="API_RS_GetRecommendations_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS .NET V4용 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS Python용 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetRecommendations)