Giao diện biểu thị tải trọng thông báo thông báo API cũ FCM. Nội dung thông báo cho phép nhà phát triển gửi tối đa 4KB cặp khoá-giá trị được xác định trước. Dưới đây là các khoá được chấp nhận.
Hãy xem phần Tạo yêu cầu gửi để biết mã mẫu và tài liệu chi tiết.
Chữ ký:
export interface NotificationMessagePayload
Thuộc tính
| Tài sản | Loại | Mô tả |
|---|---|---|
| huy hiệu | chuỗi | Giá trị của huy hiệu trên biểu tượng ứng dụng trên màn hình chính.Nếu bạn không chỉ định, thì huy hiệu sẽ không thay đổi.Nếu bạn đặt thành 0, thì huy hiệu này sẽ bị xoá.**Nền tảng:** iOS |
| phần thân | chuỗi | Văn bản nội dung của thông báo.**Nền tảng:** iOS, Android, Web |
| bodyLocArgs | chuỗi | Giá trị chuỗi biến sẽ được dùng thay cho thông số định dạng trong body_loc_key để bản địa hoá văn bản nội dung theo nội dung bản địa hoá hiện tại của người dùng.Giá trị này phải là một mảng JSON được tạo chuỗi.**iOS:** Tương ứng với loc-args trong tải trọng APN. Xem phần Tài liệu tham khảo về khoá tải trọng và Bản địa hoá nội dung thông báo từ xa để biết thêm thông tin.**Android:** Xem phần Định dạng và kiểu để biết thêm thông tin.**Nền tảng:** iOS, Android |
| bodyLocKey | chuỗi | Khoá cho chuỗi nội dung trong tài nguyên chuỗi của ứng dụng sẽ được dùng để bản địa hoá văn bản nội dung theo nội dung bản địa hoá hiện tại của người dùng.**iOS:** Tương ứng với loc-key trong tải trọng APN. Xem Tài liệu tham khảo về khoá tải trọng và Bản địa hoá nội dung thông báo từ xa để biết thêm thông tin.**Android:** Xem Tài nguyên về chuỗi để biết thêm thông tin.**Nền tảng:** iOS, Android |
| clickAction | chuỗi | Hành động liên quan đến lượt nhấp của người dùng vào thông báo. Nếu được chỉ định, một hoạt động có Bộ lọc ý định trùng khớp sẽ chạy khi người dùng nhấp vào thông báo.* **Nền tảng:** Android |
| màu sắc | chuỗi | Màu của biểu tượng thông báo, được thể hiện ở định dạng #rrggbb.**Nền tảng:** Android |
| biểu tượng | chuỗi | Biểu tượng của thông báo.**Android:** Đặt biểu tượng thông báo thành myicon cho tài nguyên có thể vẽ myicon. Nếu bạn không gửi khoá này trong yêu cầu, thì FCM sẽ hiển thị biểu tượng trình chạy được chỉ định trong tệp kê khai ứng dụng của bạn.**Web:** URL để sử dụng cho biểu tượng thông báo.**Nền tảng:** Android, Web |
| âm thanh | chuỗi | Âm thanh sẽ được phát khi thiết bị nhận được thông báo. Hỗ trợ "mặc định" cho âm thanh thông báo mặc định của thiết bị hoặc tên tệp của tài nguyên âm thanh được nhóm trong ứng dụng. Tệp âm thanh phải nằm trong /res/raw/.**Nền tảng:** Android |
| thẻ | chuỗi | Giá trị nhận dạng dùng để thay thế thông báo hiện có trong ngăn thông báo.Nếu không được chỉ định, mỗi yêu cầu sẽ tạo một thông báo mới.Nếu được chỉ định và thông báo có cùng thẻ đã hiển thị, thì thông báo mới sẽ thay thế thông báo hiện có trong ngăn thông báo.**Nền tảng:** Android |
| tiêu đề | chuỗi | Tiêu đề của thông báo.**Nền tảng:** iOS, Android, Web |
| titleLocArgs | chuỗi | Giá trị chuỗi biến sẽ được dùng thay cho thông số định dạng trong title_loc_key để bản địa hoá văn bản tiêu đề theo nội dung bản địa hoá hiện tại của người dùng.Giá trị này phải là một mảng JSON được tạo chuỗi.**iOS:** Tương ứng với title-loc-args trong tải trọng APN. Xem phần Tài liệu tham khảo về khoá tải trọng và Bản địa hoá nội dung thông báo từ xa để biết thêm thông tin.**Android:** Xem phần Định dạng và kiểu để biết thêm thông tin.**Nền tảng:** iOS, Android |
| titleLocKey | chuỗi | Khoá cho chuỗi tiêu đề trong tài nguyên chuỗi của ứng dụng sẽ được dùng để bản địa hoá văn bản tiêu đề theo nội dung bản địa hoá hiện tại của người dùng.**iOS:** Tương ứng với title-loc-key trong tải trọng APN. Xem Tài liệu tham khảo về khoá tải trọng và Bản địa hoá nội dung thông báo từ xa để biết thêm thông tin.**Android:** Xem Tài nguyên về chuỗi để biết thêm thông tin.**Nền tảng:** iOS, Android |
NotificationMessagePayload.badge
Giá trị của huy hiệu trên biểu tượng ứng dụng trên màn hình chính.
Nếu không được chỉ định, huy hiệu sẽ không thay đổi.
Nếu bạn đặt thành 0 thì huy hiệu sẽ bị xoá.
**Nền tảng:** iOS
Chữ ký:
badge?: string;
NotificationMessagePayload.body
Văn bản nội dung của thông báo.
**Nền tảng:** iOS, Android, Web
Chữ ký:
body?: string;
NotificationMessagePayload.bodyLocArgs
Các giá trị chuỗi biến được dùng thay cho thông số định dạng trong body_loc_key và dùng để bản địa hoá văn bản nội dung theo nội dung bản địa hoá hiện tại của người dùng.
Giá trị phải là một mảng JSON dạng chuỗi.
**iOS:** Tương ứng với loc-args trong tải trọng APN. Xem Tài liệu tham khảo về khoá tải trọng và Bản địa hoá nội dung thông báo từ xa để biết thêm thông tin.
**Android:** Xem phần Định dạng và định kiểu để biết thêm thông tin.
**Nền tảng:** iOS, Android
Chữ ký:
bodyLocArgs?: string;
NotificationMessagePayload.bodyLocKey
Khoá cho chuỗi nội dung trong tài nguyên chuỗi của ứng dụng được dùng để bản địa hoá văn bản nội dung theo nội dung bản địa hoá hiện tại của người dùng.
**iOS:** Tương ứng với loc-key trong tải trọng APN. Xem Tài liệu tham khảo về khoá tải trọng và Bản địa hoá nội dung thông báo từ xa để biết thêm thông tin.
**Android:** Xem bài viết Tài nguyên chuỗi để biết thêm thông tin.
**Nền tảng:** iOS, Android
Chữ ký:
bodyLocKey?: string;
NotificationMessagePayload.clickAction
Hành động liên quan đến lượt nhấp của người dùng vào thông báo. Nếu được chỉ định, một hoạt động có Bộ lọc ý định phù hợp sẽ chạy khi người dùng nhấp vào thông báo.
* **Nền tảng:** Android
Chữ ký:
clickAction?: string;
NotificationMessagePayload.color
Màu của biểu tượng thông báo, được thể hiện ở định dạng #rrggbb.
**Nền tảng:** Android
Chữ ký:
color?: string;
NotificationMessagePayload.icon
Biểu tượng của thông báo.
**Android:** Đặt biểu tượng thông báo thành myicon cho tài nguyên có thể vẽ myicon. Nếu bạn không gửi khoá này trong yêu cầu, FCM sẽ hiển thị biểu tượng trình chạy được chỉ định trong tệp kê khai ứng dụng của bạn.
**Web:** URL dùng cho biểu tượng thông báo.
**Nền tảng:** Android, Web
Chữ ký:
icon?: string;
NotificationMessagePayload.sound
Âm thanh sẽ được phát khi thiết bị nhận được thông báo. Hỗ trợ "mặc định" cho âm thanh thông báo mặc định của thiết bị hoặc tên tệp của tài nguyên âm thanh được nhóm trong ứng dụng. Các tệp âm thanh phải nằm trong /res/raw/.
**Nền tảng:** Android
Chữ ký:
sound?: string;
NotificationMessagePayload.tag
Giá trị nhận dạng dùng để thay thế thông báo hiện có trong ngăn thông báo.
Nếu không được chỉ định, mỗi yêu cầu sẽ tạo một thông báo mới.
Nếu được chỉ định và thông báo có cùng thẻ đã được hiển thị thì thông báo mới sẽ thay thế thông báo hiện có trong ngăn thông báo.
**Nền tảng:** Android
Chữ ký:
tag?: string;
NotificationMessagePayload.title
Tiêu đề của thông báo.
**Nền tảng:** iOS, Android, Web
Chữ ký:
title?: string;
NotificationMessagePayload.titleLocArgs
Sử dụng các giá trị chuỗi biến thay cho thông số định dạng trong title_loc_key để bản địa hoá văn bản tiêu đề theo bản dịch hiện tại của người dùng.
Giá trị phải là một mảng JSON dạng chuỗi.
**iOS:** Tương ứng với title-loc-args trong tải trọng APN. Xem Tài liệu tham khảo về khoá tải trọng và Bản địa hoá nội dung thông báo từ xa để biết thêm thông tin.
**Android:** Xem phần Định dạng và định kiểu để biết thêm thông tin.
**Nền tảng:** iOS, Android
Chữ ký:
titleLocArgs?: string;
NotificationMessagePayload.titleLocKey
Khoá cho chuỗi tiêu đề trong tài nguyên chuỗi của ứng dụng được dùng để bản địa hoá văn bản tiêu đề theo nội dung bản địa hoá hiện tại của người dùng.
**iOS:** Tương ứng với title-loc-key trong tải trọng APN. Xem Tài liệu tham khảo về khoá tải trọng và Bản địa hoá nội dung thông báo từ xa để biết thêm thông tin.
**Android:** Xem bài viết Tài nguyên chuỗi để biết thêm thông tin.
**Nền tảng:** iOS, Android
Chữ ký:
titleLocKey?: string;