지원 종료 공지: 2026년 10월 30일에 AWS 는 Amazon Pinpoint에 대한 지원을 종료합니다. 2026년 10월 30일 이후에는 Amazon Pinpoint 콘솔 또는 Amazon Pinpoint 리소스(엔드포인트, 세그먼트, 캠페인, 여정 및 분석)에 더 이상 액세스할 수 없습니다. 자세한 내용은 Amazon Pinpoint 지원 종료를 참조하세요. 참고: SMS, 음성, 모바일 푸시, OTP 및 전화번호 검증과 관련된 APIs는이 변경의 영향을 받지 않으며 AWS 최종 사용자 메시징에서 지원됩니다.
기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
GetInAppMessages Amazon Pinpoint API 응답 JSON 예제
GetInAppMessages API 작업을 직접적으로 호출하면 지정된 엔드포인트에 권한이 부여된 메시지 목록이 반환됩니다. 이렇게 되면 앱이 응답의 값을 기반으로 메시지를 렌더링할 수 있습니다.
아래는 GetInAppMessages API를 직접적으로 호출할 때 반환되는 JSON 객체의 예제입니다.
{ "InAppMessagesResponse":{ "InAppMessageCampaigns":[ { "CampaignId":"inAppTestCampaign-4c545b28d21a490cb51b0b364example", "DailyCap":0, "InAppMessage":{ "Content":[ { "BackgroundColor":"#f8e71c", "BodyConfig":{ "Alignment":"CENTER", "Body":"This is a sample in-app message sent using Amazon Pinpoint.", "TextColor":"#d0021b" }, "HeaderConfig":{ "Alignment":"CENTER", "Header":"Sample In-App Message", "TextColor":"#d0021b" }, "ImageUrl":"https://example.com/images/thumbnail.png", "PrimaryBtn":{ "DefaultConfig":{ "BackgroundColor":"#d0021b", "BorderRadius":50, "ButtonAction":"CLOSE", "Text":"Dismiss", "TextColor":"#f8e71c" } } } ], "Layout":"MIDDLE_BANNER" }, "Priority":3, "Schedule":{ "EndDate":"2021-11-06T00:08:05Z", "EventFilter":{ "Dimensions":{ "Attributes":{ }, "EventType":{ "DimensionType":"INCLUSIVE", "Values":[ "_session.start" ] }, "Metrics":{ } } } }, "SessionCap":0, "TotalCap":0, "TreatmentId":"0" } ] } }
다음 섹션에서는 이 응답의 구성 요소 및 해당 속성에 대한 추가 정보를 제공합니다.
InAppMessageCampaigns 객체
각 InAppMessageCampaigns 객체에는 다음 속성이 포함됩니다.
| 속성 | 설명 | 설정 위치 |
|---|---|---|
|
메시지를 보낸 Amazon Pinpoint 캠페인의 이름 및 고유한 캠페인 ID가 포함된 문자열입니다. 이름은 캠페인 ID 앞에 옵니다. 두 값은 하이픈(-)으로 구분됩니다. |
캠페인을 생성할 경우 Amazon Pinpoint에서 자동으로 생성합니다. |
|
이 메시지에 대한 캠페인 처리 ID를 나타내는 정수입니다. 캠페인에 처리가 한 개만 있는 경우 값은 |
|
|
인앱 메시지의 우선순위로, 1~5 사이의 정수로 표시됩니다. 여기서 1은 가장 높은 우선순위를 나타내고, 5는 가장 낮은 우선순위를 나타냅니다. |
캠페인 생성 프로세스의 1단계. |
|
메시지가 렌더링되는 방식에 대한 정보가 들어 있는 InAppMessage 객체입니다. |
캠페인에 지정된 인앱 메시지 템플릿의 콘텐츠를 기반으로 합니다. |
|
메시지를 보낸 시간에 대한 정보가 들어 있는 Schedule 객체입니다. |
캠페인 생성 프로세스의 4단계(콘솔에서 캠페인이 생성된 경우) 또는 |
|
24시간 동안 인앱 메시지가 사용자에게 표시될 수 있는 횟수(정수로 표시)입니다. |
프로젝트 수준 설정에서 상속됩니다. 캠페인에 프로젝트 설정을 재정의하는 설정이 포함된 경우 해당 설정이 대신 사용됩니다. |
|
애플리케이션 세션 중에 사용자에게 인앱 메시지가 표시될 수 있는 횟수(정수로 표시)입니다. |
|
|
캠페인당 인앱 메시지가 엔드포인트에 표시될 수 있는 총 횟수(정수로 표시)입니다. |
InAppMessage 객체
각 InAppMessage 객체에는 다음 속성이 포함됩니다.
| 속성 | 설명 | 설정 위치 |
|---|---|---|
|
메시지 내용을 설명하는 InAppMessageContent 객체가 포함된 배열입니다. |
캠페인에 지정된 인앱 메시지 템플릿의 콘텐츠를 기반으로 합니다. |
|
인앱 메시지가 수신자의 디바이스에 표시되는 방식을 설명하는 문자열입니다. 가능한 값은 다음과 같습니다.
|
HeaderConfig 객체
각 HeaderConfig 객체에는 다음 속성이 포함됩니다.
| 속성 | 설명 | 설정 위치 |
|---|---|---|
|
헤더 텍스트의 텍스트 정렬을 지정하는 문자열입니다. 가능한 값은 |
캠페인에 지정된 인앱 메시지 템플릿의 콘텐츠를 기반으로 합니다. |
|
메시지 헤더 텍스트입니다. |
|
|
16진수 색상 코드를 설명하는 문자열로 표현되는 헤더 텍스트의 색입니다(예: 검은색의 경우 '#000000'). |
BodyConfig 객체
각 BodyConfig 객체에는 다음 속성이 포함됩니다.
| 속성 | 설명 | 설정 위치 |
|---|---|---|
|
메시지 본문의 텍스트 정렬을 지정하는 문자열입니다. 가능한 값은 |
캠페인에 지정된 인앱 메시지 템플릿의 콘텐츠를 기반으로 합니다. |
|
메시지의 본문 텍스트입니다. |
|
|
16진수 색상 코드가 포함된 문자열로 표현되는 본문 텍스트의 색상입니다(예: 검정색의 경우 '#000000'). |
InAppMessageContent 객체
각 InAppMessageContent 객체에는 다음 속성이 포함됩니다.
| 속성 | 설명 | 설정 위치 |
|---|---|---|
|
16진수 색상 코드가 포함된 문자열로 표시되는 인앱 메시지의 배경색입니다(예: 검은색의 경우 '#000000'). |
캠페인에 지정된 인앱 메시지 템플릿의 콘텐츠를 기반으로 합니다. |
|
메시지의 본문 내용과 관련된 정보가 포함되어 있는 BodyConfig 객체입니다. |
|
|
메시지의 헤더 또는 제목과 관련된 정보가 포함되어 있는 HeaderConfig 객체입니다. |
|
|
메시지에 표시되는 이미지의 URL입니다. |
|
|
메시지의 기본 버튼에 대한 정보가 포함되어 있는 InAppMessageButton 객체입니다. |
|
|
메시지의 보조 버튼에 대한 정보가 포함되어 있는 InAppMessageButton 객체입니다. 인앱 메시지 템플릿에 보조 버튼이 지정되지 않은 경우에는 표시되지 않습니다. |
Schedule 객체
각 Schedule 객체에는 다음 속성이 포함됩니다.
| 속성 | 설명 | 설정 위치 |
|---|---|---|
|
캠페인이 종료될 예정인 ISO 8601 형식의 예약 시간입니다. |
캠페인 생성 프로세스의 4단계(콘솔에서 캠페인이 생성된 경우) 또는 |
|
인앱 메시지를 표시하게 하는 이벤트에 대한 정보입니다. Amazon Pinpoint 인앱 캠페인과 일치하는 이벤트를 생성하면 메시지가 표시됩니다. |
InAppMessageButton 객체
InAppMessageButton 객체에는 다음 속성이 포함됩니다.
| 속성 | 설명 | 설정 위치 |
|---|---|---|
|
인앱 메시지에 있는 버튼의 기본 설정에 대한 정보가 포함되어 있는 DefaultButtonConfig 객체입니다. |
캠페인에 지정된 인앱 메시지 템플릿의 콘텐츠를 기반으로 합니다. |
|
Android 디바이스에서 버튼이 동작하는 방식을 지정하는 OverrideButtonConfig 객체입니다. 이는 |
|
|
iOS 디바이스에서 버튼이 동작하는 방식을 지정하는 OverrideButtonConfig 객체입니다. 이는 |
|
|
웹 앱에서 버튼이 동작하는 방식을 지정하는 OverrideButtonConfig 객체입니다. 이는 |
DefaultButtonConfig 객체
DefaultButtonConfig 객체에는 다음 속성이 포함됩니다.
| 속성 | 설명 | 설정 위치 |
|---|---|---|
|
16진수 색상 코드가 포함된 문자열로 표시되는 버튼의 배경색입니다(예: 검은색의 경우 '#000000'). |
캠페인에 지정된 인앱 메시지 템플릿의 콘텐츠를 기반으로 합니다. |
|
버튼 테두리의 반경(픽셀 단위)으로, 정수로 표현됩니다. 숫자가 클수록 모서리가 더 둥글어집니다. | |
|
수신자가 인앱 메시지에서 버튼을 선택할 때 수행되는 작업을 설명하는 문자열입니다. 가능한 값은 다음과 같습니다.
|
|
|
버튼의 대상 URL입니다. ButtonAction이 |
|
|
버튼에 표시되는 텍스트입니다. | |
|
16진수 색상 코드가 포함된 문자열로 표시되는 텍스트의 색입니다(예: 검은색의 경우 '#000000'). |
OverrideButtonConfig 객체
OverrideButtonConfig 객체는 인앱 메시지 템플릿이 재정의 버튼을 사용하는 경우에만 표시됩니다. 재정의 버튼은 iOS 디바이스, Android 디바이스 또는 웹 브라우저와 같은 특정 디바이스 유형에 대한 특정한 구성이 있는 버튼입니다.
OverrideButtonConfig 객체에는 다음 속성이 포함됩니다.
| 속성 | 설명 | 설정 위치 |
|---|---|---|
|
수신자가 인앱 메시지에서 버튼을 선택할 때 수행되는 작업입니다. 가능한 값은 다음과 같습니다.
|
캠페인에 지정된 인앱 메시지 템플릿의 콘텐츠를 기반으로 합니다. |
|
버튼의 대상 URL입니다. |
|
|
버튼에 표시되는 텍스트입니다. | |
|
16진수 색상 코드가 포함된 문자열로 표시되는 텍스트의 색입니다(예: 검은색의 경우 '#000000'). |
