키-값 페어
이 페이지에서는 키-값 페어를 사용하여 사용자 기기에 추가 데이터 페이로드를 전송하는 방법을 다룹니다. 이 기능은 푸시, 인앱, 이메일 및 콘텐츠 카드 메시징 채널에서 사용할 수 있습니다.
키-값 페어를 사용하여 메시지에 구조화된 메타데이터를 추가할 수 있습니다. 이러한 추가 데이터 페이로드는 메시지가 렌더링되거나 처리되는 방식에 영향을 줄 수 있는 추가 상황별 정보로 메시지를 풍부하게 만들 수 있습니다.
키-값 페어는 메타데이터이므로 이 데이터가 반드시 수신자에게 표시되는 것은 아니지만, 연결된 시스템이나 프로세스에서 메시지 처리를 커스터마이즈하는 데 사용할 수 있습니다.
각 페어는 다음으로 구성됩니다:
- 키: 식별자 (예:
utm_source) - 값: 연결된 데이터 (예:
newsletter)
활용 사례
다음은 키-값 페어로 메타데이터를 추가하는 활용 사례 예시입니다:
- 추적 파라미터: 분석 목적으로 UTM 파라미터 첨부
- 키:
utm_campaign - 값:
spring_sale
- 키:
- 커스텀 태그: 내부 라우팅 또는 분류를 위한 태그 추가
- 키:
priority - 값:
high
- 키:
- 동작 트리거: 인앱 동작을 트리거하거나 커스터마이즈하는 데 사용되는 메타데이터
- 키:
deep_link - 값:
app://promo-page
- 키:
푸시 알림
키-값 페어는 Android, iOS 및 웹 푸시 알림에 추가할 수 있습니다. 키-값 페어를 사용하여 내부 측정기준 및 앱 콘텐츠를 업데이트하거나 알림 우선순위, 현지화, 사운드 등의 푸시 알림 등록정보를 커스터마이즈할 수 있습니다.
메시지 작성기에서 설정 탭을 선택하고 새 페어 추가를 선택한 다음 키-값 페어를 지정합니다.
iOS
Apple 푸시 알림 서비스(APNs)는 키-값 페어를 사용하여 알림 기본 설정을 지정하고 커스텀 데이터를 전송하는 것을 지원합니다. APNs는 알림 등록정보를 제어하는 미리 정의된 키와 값을 포함하는 Apple 예약 aps 라이브러리를 사용합니다.
APS 라이브러리
| 키 | 값 유형 | 값 설명 |
|---|---|---|
| alert | 문자열 또는 사전 오브젝트 | 문자열 입력의 경우 닫기 및 보기 버튼과 함께 문자열을 메시지로 표시하는 알림을 표시합니다. 문자열이 아닌 입력의 경우 입력의 하위 등록정보에 따라 알림 또는 배너를 표시합니다 |
| badge | 숫자 | 앱 아이콘에 배지로 표시되는 숫자를 제어합니다 |
| sound | 문자열 | 알림으로 재생할 사운드 파일의 이름입니다. 앱 번들 또는 Library/Sounds 폴더에 있어야 합니다 |
| content-available | 숫자 | 입력 값 1은 앱 시작 또는 세션 재개 시 새로운 정보의 가용성을 앱에 알립니다 |
알림 등록정보 라이브러리
| 키 | 값 유형 | 값 설명 |
|---|---|---|
| title | 문자열 | Apple Watch가 알림의 일부로 간략하게 표시하는 짧은 문자열 |
| body | 문자열 | 푸시 알림의 콘텐츠 |
| title-loc-key | 문자열 또는 null | Localizable.strings 파일에서 현재 현지화에 대한 제목 문자열을 설정하는 키 |
| title-loc-args | 문자열 배열 또는 null | title-loc-key의 제목 현지화 형식 지정자 대신 표시될 수 있는 문자열 값 |
| action-loc-key | 문자열 배열 또는 null | 지정된 경우 해당 문자열이 닫기 및 보기 버튼의 현지화를 설정합니다 |
| loc-key | 문자열 또는 null | Localizable.strings 파일에서 현재 현지화에 대한 알림 메시지를 설정하는 키 |
| loc-args | 문자열 배열 | loc-key의 현지화 형식 지정자 대신 표시될 수 있는 문자열 값 |
| launch-image | 문자열 | 사용자가 실행 버튼을 탭하거나 실행 슬라이드를 이동할 때 시작 이미지로 사용할 앱 번들의 이미지 파일 이름 |
Braze 메시지 작성기는 다음 키의 생성을 자동으로 처리합니다: alert 및 해당 등록정보, content-available, sound, category.
이러한 값은 푸시 메시지를 작성할 때 설정 탭에서 입력할 수 있습니다. 알림 옵션을 선택하고 알림 사전 키를 선택하면 새 키-값 항목에 키가 자동으로 채워집니다.

Braze가 APNs에 푸시 알림을 전송하면 페이로드는 JSON으로 포맷됩니다.
간단한 페이로드
1
2
3
{
"aps" : { "alert" : "Message received from Spencer" },
}
복잡한 페이로드
1
2
3
4
5
6
7
8
9
10
11
12
{
"aps" : {
"alert" : {
"body" : "Hi, welcome to our app!",
"loc-key" : "France",
"loc-args" : ["Bonjour", "bienvenue"],
"action-loc-key" : "Button_Type_1",
"launch-image" : "Paris"
},
"content-available" : 1
},
}
커스텀 키-값 페어
aps 라이브러리 페이로드 값 외에도 사용자 기기에 커스텀 키-값 페어를 전송할 수 있습니다. 이러한 페어의 값은 기본 유형인 사전(오브젝트), 배열, 문자열, 숫자, 부울로 제한됩니다.

커스텀 키-값 페어의 사용 사례에는 내부 측정기준 관리 및 사용자 인터페이스의 컨텍스트 설정이 포함되지만 이에 국한되지 않습니다. Braze에서는 extras 키를 통해 애플리케이션 내에서 사용할 수 있도록 푸시 알림과 함께 추가 키-값 페어를 전송할 수 있습니다. 다른 키를 사용하려면 앱이 해당 커스텀 키를 처리할 수 있는지 확인하세요.
애플리케이션에서 ab라는 최상위 키 또는 사전을 처리하지 않도록 해야 합니다.
Apple은 고객 정보나 민감한 데이터를 커스텀 페이로드 데이터로 포함하지 않도록 권장합니다. 또한 Apple은 알림 메시지와 관련된 모든 동작이 기기의 데이터를 삭제하지 않도록 권장합니다.
HTTP/2 공급자 API를 사용하는 경우 APNs에 전송하는 개별 페이로드의 크기가 4096바이트를 초과할 수 없습니다. 곧 지원이 중단될 레거시 바이너리 인터페이스는 2048바이트의 페이로드 크기만 지원합니다.
API 트리거 캠페인
Braze에서는 extras라고 하는 커스텀 정의 문자열 키-값 페어를 전송할 수 있습니다. API 트리거 및 예약된 API 트리거 캠페인에서 extras에 액세스하려면 대시보드에서 키를 “example_key”로, 값을 "$json:{"foo": 1, "bar": 1}"로 설정합니다. 그러면 개발자 콘솔 출력이 "extras": { "test": { "foo": 1, "bar": 1 }가 됩니다.
Android
Braze에서는 키-값 페어를 사용하여 푸시 알림에 추가 데이터 페이로드를 전송할 수 있습니다.
데이터 페이로드
iOS 푸시와 마찬가지로 사용자 기기에 커스텀 키-값 페어를 전송할 수 있습니다.
커스텀 키-값 페어의 일부 사용 사례에는 내부 측정기준 관리 및 사용자 인터페이스의 컨텍스트 설정이 포함되지만, 원하는 목적에 맞게 사용할 수 있습니다.
데이터 페이로드가 제대로 작동하려면 앱의 백엔드에서 커스텀 키-값 페어를 처리할 수 있어야 합니다.
API 트리거 캠페인
Braze에서는 extras라고 하는 커스텀 정의 문자열 키-값 페어를 전송할 수 있습니다. API 트리거 및 예약된 API 트리거 캠페인에서 extras에 액세스하려면 대시보드에서 키를 “example_key”로, 값을 "$json:{"foo": 1, "bar": 1}"로 설정합니다. 그러면 개발자 콘솔 출력이 "extras": { "test": { "foo": 1, "bar": 1 }가 됩니다.
FCM 메시징 옵션
Android 푸시 알림은 FCM 메시지 옵션으로 추가 커스터마이즈할 수 있습니다. 여기에는 알림 우선순위, 사운드, 지연, 수명 및 축소 가능성이 포함됩니다. 이러한 값은 푸시 메시지를 생성할 때 설정 탭에서 지정할 수 있습니다. Braze 메시지 작성기에서 이러한 옵션을 설정하는 방법에 대한 자세한 내용은 고급 푸시 알림 설정을 참조하세요.

무음 푸시 알림
무음 푸시 알림은 알림 메시지나 사운드가 없는 푸시 알림으로, 백그라운드에서 앱의 인터페이스나 콘텐츠를 업데이트하는 데 사용됩니다. 이러한 알림은 키-값 페어를 사용하여 백그라운드 앱 동작을 트리거합니다. 무음 푸시 알림은 제거 추적도 지원합니다.
마케터는 무음 푸시 알림을 앱 사용자에게 전송하기 전에 예상되는 동작을 트리거하는지 테스트해야 합니다. iOS 또는 Android 무음 푸시 알림을 작성한 후 외부 사용자 ID 또는 이메일 주소로 필터링하여 테스트 사용자만 타겟팅해야 합니다.
캠페인 시작 시 테스트 기기에서 눈에 보이는 푸시 알림을 받지 않았는지 확인해야 합니다.
iOS 운영체제는 일부 기능(제거 추적, 지오펜스, 푸시 스토리)에 대해 알림을 제한할 수 있습니다. 이러한 기능에 문제가 발생하는 경우 iOS의 무음 알림 제한이 원인일 수 있습니다.
인앱 메시지
기존 편집기에서 설정 탭을 선택하고 새 페어 추가를 선택한 다음 키-값 페어를 지정하여 인앱 메시지에 키-값 페어를 추가할 수 있습니다.
인앱 메시지의 드래그 앤 드롭 편집기에서는 키-값 페어를 설정할 수 없습니다.

API 트리거 캠페인
Braze에서는 extras라고 하는 커스텀 정의 문자열 키-값 페어를 전송할 수 있습니다. API 트리거 및 예약된 API 트리거 캠페인에서 extras에 액세스하려면 대시보드에서 키를 “example_key”로, 값을 "$json:{"foo": 1, "bar": 1}"로 설정합니다. 그러면 개발자 콘솔 출력이 "extras": { "test": { "foo": 1, "bar": 1 }가 됩니다.
이메일
SparkPost와 SendGrid 모두 이메일에서 키-값 페어를 지원합니다. SendGrid를 사용하는 경우 키-값 페어는 고유 인수로 전송됩니다. SendGrid에서는 최대 10,000바이트의 데이터까지 무제한의 키-값 페어를 첨부할 수 있습니다. 이러한 키-값 페어는 SendGrid 이벤트 웹훅의 게시물에서 확인할 수 있습니다.
반송된 이메일은 SparkPost 또는 SendGrid에 키-값 페어를 전달하지 않습니다.

콘텐츠 카드
콘텐츠 카드에 키-값 페어를 추가하려면 Braze 메시지 작성기의 설정 탭으로 이동하여 새 페어 추가를 선택합니다.
