FCM 기존 API 알림 메시지 페이로드를 나타내는 인터페이스입니다. 개발자는 알림 메시지를 통해 최대 4KB의 사전 정의된 키-값 쌍을 보낼 수 있습니다. 허용되는 키는 아래에 설명되어 있습니다.
코드 샘플 및 자세한 문서는 전송 요청 작성을 참고하세요.
서명:
export interface NotificationMessagePayload
속성
| 속성 | 유형 | 설명 |
|---|---|---|
| 배지 | 문자열 | 홈 화면 앱 아이콘의 배지 값입니다.지정하지 않으면 배지가 변경되지 않습니다.0로 설정하면 배지가 삭제됩니다.**플랫폼:** iOS |
| 본문 | 문자열 | 알림의 본문 텍스트입니다.**플랫폼:** iOS, Android, 웹 |
| bodyLocArgs | 문자열 | 본문 텍스트를 사용자의 현재 지역으로 현지화하는 데 사용할 body_loc_key의 형식 지정자 대신 사용될 변수 문자열 값입니다.이 값은 문자열화된 JSON 배열이어야 합니다.**iOS:** APN 페이로드의 loc-args에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요.**Android:** 자세한 내용은 형식 및 스타일 지정을 참조하세요.**플랫폼:** iOS, Android |
| bodyLocKey로 변경됩니다. | 문자열 | 앱의 문자열 리소스에서 본문을 사용자의 현재 지역으로 현지화하는 데 사용할 본문 문자열의 키입니다.**iOS:** APN 페이로드의 loc-key에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요.**Android:** 자세한 내용은 문자열 리소스를 참조하세요.**플랫폼:** iOS, Android |
| 클릭 작업 | 문자열 | 사용자의 알림 클릭과 관련된 작업입니다. 지정하면 사용자가 알림을 클릭할 때 일치하는 인텐트 필터가 있는 활동이 실행됩니다.* **플랫폼:** Android |
| 색상 | 문자열 | #rrggbb 형식으로 표현된 알림 아이콘의 색상입니다.**플랫폼:** Android |
| 아이콘 | 문자열 | 알림 아이콘입니다.**Android:** 드로어블 리소스 myicon의 알림 아이콘을 myicon로 설정합니다. 요청에서 이 키를 전송하지 않으면 FCM은 앱 매니페스트에 지정된 런처 아이콘을 표시합니다.**웹:** 알림 아이콘에 사용할 URL입니다.**플랫폼:** Android, 웹 |
| 소리 | 문자열 | 기기가 알림을 수신하면 재생되는 알림음입니다. '기본값' 지원 을 선택합니다. 사운드 파일은 /res/raw/에 있어야 합니다.**플랫폼:** Android |
| 태그 | 문자열 | 알림 창의 기존 알림을 대체하는 데 사용되는 식별자입니다.지정하지 않으면 각 요청이 새 알림을 만듭니다.지정된 경우 동일한 태그의 알림이 이미 표시되고 있는 경우, 새 알림이 알림 창의 기존 알림을 대체합니다.**플랫폼:** Android |
| title | 문자열 | 알림의 제목입니다.**플랫폼:** iOS, Android, 웹 |
| titleLocArgs | 문자열 | 제목 텍스트를 사용자의 현재 지역으로 현지화하는 데 사용할 title_loc_key의 형식 지정자 대신 사용될 변수 문자열 값입니다.이 값은 문자열화된 JSON 배열이어야 합니다.**iOS:** APN 페이로드의 title-loc-args에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요.**Android:** 자세한 내용은 형식 및 스타일 지정을 참조하세요.**플랫폼:** iOS, Android |
| titleLocKey입니다. | 문자열 | 앱의 문자열 리소스에서 제목 텍스트를 사용자의 현재 지역으로 현지화하는 데 사용할 제목 문자열의 키입니다.**iOS:** APN 페이로드의 title-loc-key에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요.**Android:** 자세한 내용은 문자열 리소스를 참조하세요.**플랫폼:** iOS, Android |
알림 메시지 페이로드.배지
홈 화면 앱 아이콘의 배지 값입니다.
지정하지 않으면 배지가 변경되지 않습니다.
0로 설정하면 배지가 삭제됩니다.
**플랫폼:** iOS
서명:
badge?: string;
NotificationMessagePayload.body
알림의 본문입니다.
**플랫폼:** iOS, Android, 웹
서명:
body?: string;
NotificationMessagePayload.bodyLocArgs
본문 텍스트를 사용자의 현재 지역으로 현지화하는 데 사용할 body_loc_key의 형식 지정자 대신 사용될 변수 문자열 값입니다.
값은 문자열화된 JSON 배열이어야 합니다.
**iOS:** APN 페이로드의 loc-args에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요.
**Android:** 자세한 내용은 서식 및 스타일 지정을 참고하세요.
**플랫폼:** iOS, Android
서명:
bodyLocArgs?: string;
NotificationMessagePayload.bodyLocKey
앱의 문자열 리소스에서 본문 텍스트를 사용자의 현재 지역으로 현지화하는 데 사용할 본문 문자열의 키입니다.
**iOS:** APN 페이로드의 loc-key에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요.
**Android:** 자세한 내용은 문자열 리소스를 참고하세요.
**플랫폼:** iOS, Android
서명:
bodyLocKey?: string;
NotificationMessagePayload.clickAction
사용자의 알림 클릭과 관련된 작업입니다. 지정하면 사용자가 알림을 클릭할 때 일치하는 인텐트 필터가 있는 활동이 실행됩니다.
* **플랫폼:** Android
서명:
clickAction?: string;
NotificationMessagePayload.color
#rrggbb 형식으로 표현한 알림 아이콘의 색상입니다.
**플랫폼:** Android
서명:
color?: string;
NotificationMessagePayload.icon
알림 아이콘입니다.
**Android:** 드로어블 리소스 myicon의 알림 아이콘을 myicon로 설정합니다. 요청에서 이 키를 전송하지 않으면 FCM은 앱 매니페스트에 지정된 런처 아이콘을 표시합니다.
**웹:** 알림 아이콘에 사용할 URL입니다.
**플랫폼:** Android, 웹
서명:
icon?: string;
NotificationMessage페이로드.사운드
기기가 알림을 수신하면 재생되는 알림음입니다. '기본값' 지원 을 선택합니다. 사운드 파일은 /res/raw/에 있어야 합니다.
**플랫폼:** Android
서명:
sound?: string;
NotificationMessagePayload.tag
알림 창에서 기존 알림을 대체하는 데 사용되는 식별자입니다.
지정하지 않으면 각 요청이 새 알림을 만듭니다.
지정하면 태그가 동일한 알림이 이미 표시되고 있는 경우 새 알림이 알림 창의 기존 알림을 대체합니다.
**플랫폼:** Android
서명:
tag?: string;
NotificationMessagePayload.title
알림의 제목입니다.
**플랫폼:** iOS, Android, 웹
서명:
title?: string;
NotificationMessagePayload.titleLocArgs
제목 텍스트를 사용자의 현재 지역으로 현지화하는 데 사용할 title_loc_key의 형식 지정자 대신 사용될 변수 문자열 값입니다.
값은 문자열화된 JSON 배열이어야 합니다.
**iOS:** APN 페이로드의 title-loc-args에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요.
**Android:** 자세한 내용은 서식 및 스타일 지정을 참고하세요.
**플랫폼:** iOS, Android
서명:
titleLocArgs?: string;
NotificationMessagePayload.titleLocKey
앱의 문자열 리소스에서 제목 텍스트를 사용자의 현재 지역으로 현지화하는 데 사용할 제목 문자열의 키입니다.
**iOS:** APN 페이로드의 title-loc-key에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요.
**Android:** 자세한 내용은 문자열 리소스를 참고하세요.
**플랫폼:** iOS, Android
서명:
titleLocKey?: string;