FCM 레거시 API 알림 메시지 페이로드를 나타내는 인터페이스입니다. 알림 메시지를 통해 개발자는 사전 정의된 키-값 쌍을 최대 4KB까지 보낼 수 있습니다. 허용되는 키는 아래에 설명되어 있습니다.
코드 샘플 및 자세한 문서는 보내기 요청 빌드를 참조하세요.
서명:
export interface NotificationMessagePayload
속성
재산 | 유형 | 설명 |
---|---|---|
배지 | 끈 | 홈 화면 앱 아이콘의 배지 값입니다. 지정하지 않으면 배지가 변경되지 않습니다. 0 으로 설정하면 배지가 제거됩니다. **플랫폼:** iOS |
몸 | 끈 | 알림의 본문 텍스트입니다. **플랫폼:** iOS, Android, 웹 |
bodyLocArgs | 끈 | 본문 텍스트를 사용자의 현재 지역화에 맞게 지역화하는 데 사용하기 위해 body_loc_key 의 형식 지정자 대신 사용할 변수 문자열 값입니다. 값은 문자열화된 JSON 배열이어야 합니다. **iOS:** APN 페이로드의 loc-args 에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요. **Android:** 자세한 내용은 서식 및 스타일 지정을 참조하세요. **플랫폼:** iOS, Android |
몸체잠금키 | 끈 | 본문 텍스트를 사용자의 현재 지역화로 지역화하는 데 사용할 앱 문자열 리소스의 본문 문자열에 대한 키입니다. **iOS:** APN 페이로드의 loc-key 에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요. **Android:** 자세한 내용은 문자열 리소스를 참조하세요. **플랫폼:** iOS, Android |
클릭액션 | 끈 | 사용자가 알림을 클릭하는 것과 관련된 작업입니다. 지정된 경우 사용자가 알림을 클릭하면 일치하는 인텐트 필터가 있는 활동이 시작됩니다. * **플랫폼:** Android |
색상 | 끈 | #rrggbb 형식으로 표현되는 알림 아이콘의 색상입니다. **플랫폼:** 안드로이드 |
상 | 끈 | 알림 아이콘입니다. **Android:** 드로어블 리소스 myicon 에 대한 알림 아이콘을 myicon 으로 설정합니다. 요청에 이 키를 보내지 않으면 FCM은 앱 매니페스트에 지정된 실행기 아이콘을 표시합니다. **웹:** 알림 아이콘에 사용할 URL입니다. **플랫폼:** Android, 웹 |
소리 | 끈 | 장치가 알림을 받았을 때 재생할 소리입니다. 장치의 기본 알림 소리 또는 앱에 번들로 제공되는 사운드 리소스의 파일 이름에 대해 "기본값"을 지원합니다. 사운드 파일은 /res/raw/ 에 있어야 합니다. **플랫폼:** 안드로이드 |
꼬리표 | 끈 | 알림 창에서 기존 알림을 대체하는 데 사용되는 식별자입니다. 지정하지 않으면 각 요청마다 새 알림이 생성됩니다. 지정하고 동일한 태그가 있는 알림이 이미 표시되고 있는 경우 새 알림이 알림 창에 있는 기존 알림을 대체합니다. **플랫폼:** 안드로이드 |
제목 | 끈 | 알림의 제목입니다. **플랫폼:** iOS, Android, 웹 |
titleLocArgs | 끈 | 제목 텍스트를 사용자의 현재 지역화에 맞게 지역화하는 데 사용하기 위해 title_loc_key 의 형식 지정자 대신 사용할 변수 문자열 값입니다. 값은 문자열화된 JSON 배열이어야 합니다. **iOS:** APN 페이로드의 title-loc-args 에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요. **Android:** 자세한 내용은 서식 및 스타일 지정을 참조하세요. **플랫폼:** iOS, Android |
제목자물쇠 | 끈 | 제목 텍스트를 사용자의 현재 지역화로 지역화하는 데 사용할 앱 문자열 리소스의 제목 문자열에 대한 키입니다. **iOS:** APN 페이로드의 title-loc-key 에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요. **Android:** 자세한 내용은 문자열 리소스를 참조하세요. **플랫폼:** iOS, Android |
알림메시지페이로드.배지
홈 화면 앱 아이콘의 배지 값입니다.
지정하지 않으면 배지가 변경되지 않습니다.
0
으로 설정한 경우 , 배지가 제거됩니다.
**플랫폼:** iOS
서명:
badge?: string;
알림메시지페이로드.바디
알림의 본문 텍스트입니다.
**플랫폼:** iOS, Android, 웹
서명:
body?: string;
알림메시지페이로드.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;
알림메시지페이로드.클릭액션
사용자가 알림을 클릭하는 것과 관련된 작업입니다. 지정된 경우 사용자가 알림을 클릭하면 일치하는 인텐트 필터가 있는 활동이 시작됩니다.
* **플랫폼:** Android
서명:
clickAction?: string;
알림메시지페이로드.color
#rrggbb
형식으로 표현되는 알림 아이콘의 색상입니다.
**플랫폼:** 안드로이드
서명:
color?: string;
알림메시지페이로드.icon
알림 아이콘입니다.
**Android:** 드로어블 리소스 myicon
에 대한 알림 아이콘을 myicon
으로 설정합니다. . 요청에 이 키를 보내지 않으면 FCM은 앱 매니페스트에 지정된 실행기 아이콘을 표시합니다.
**웹:** 알림 아이콘에 사용할 URL입니다.
**플랫폼:** Android, 웹
서명:
icon?: string;
알림메시지페이로드.사운드
장치가 알림을 받았을 때 재생할 소리입니다. 장치의 기본 알림 소리 또는 앱에 번들로 제공되는 사운드 리소스의 파일 이름에 대해 "기본값"을 지원합니다. 사운드 파일은 /res/raw/
에 있어야 합니다. .
**플랫폼:** 안드로이드
서명:
sound?: string;
알림메시지페이로드.태그
알림 창에서 기존 알림을 대체하는 데 사용되는 식별자입니다.
지정하지 않으면 각 요청마다 새 알림이 생성됩니다.
지정하고 동일한 태그가 있는 알림이 이미 표시되고 있는 경우 새 알림이 알림 창에 있는 기존 알림을 대체합니다.
**플랫폼:** 안드로이드
서명:
tag?: string;
알림메시지페이로드.제목
알림의 제목입니다.
**플랫폼:** iOS, Android, 웹
서명:
title?: string;
알림메시지페이로드.titleLocArgs
제목 텍스트를 사용자의 현재 지역화에 맞게 지역화하는 데 사용하기 위해 title_loc_key
의 형식 지정자 대신 사용할 변수 문자열 값입니다.
값은 문자열화된 JSON 배열이어야 합니다.
**iOS:** APN 페이로드의 title-loc-args
에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요.
**Android:** 자세한 내용은 서식 및 스타일 지정을 참조하세요.
**플랫폼:** iOS, Android
서명:
titleLocArgs?: string;
알림메시지페이로드.titleLocKey
제목 텍스트를 사용자의 현재 지역화로 지역화하는 데 사용할 앱 문자열 리소스의 제목 문자열에 대한 키입니다.
**iOS:** APN 페이로드의 title-loc-key
에 해당합니다. 자세한 내용은 페이로드 키 참조 및 원격 알림 콘텐츠 현지화를 참조하세요.
**Android:** 자세한 내용은 문자열 리소스를 참조하세요.
**플랫폼:** iOS, Android
서명:
titleLocKey?: string;