Tài nguyên: LoyaltyObject
Biểu diễn dưới dạng JSON |
---|
{ "kind": string, "classReference": { object ( |
Trường | |
---|---|
kind |
Xác định loại tài nguyên này. Giá trị: chuỗi cố định |
class |
Bản sao của các trường kế thừa của lớp mẹ. Các trường này được truy xuất trong quá trình GET. |
account |
Tên chủ tài khoản khách hàng thân thiết, chẳng hạn như "John Smith". Độ dài tối đa được đề xuất là 20 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các màn hình nhỏ hơn. |
account |
Giá trị nhận dạng tài khoản khách hàng thân thiết. Độ dài tối đa đề xuất là 20 ký tự. |
loyalty |
Nhãn, số dư và loại điểm thưởng của chương trình khách hàng thân thiết. |
linked |
Danh sách đối tượng ưu đãi được liên kết với thẻ khách hàng thân thiết này. Các đối tượng ưu đãi phải tồn tại. Mã đối tượng mặt hàng phải tuân theo định dạng issuer ID.identifier, trong đó mã nhận dạng trước do Google phát hành và mã nhận dạng sau do bạn chọn. |
secondary |
Nhãn, số dư và loại điểm thưởng khách hàng thân thiết phụ. Được hiển thị bên cạnh điểm khách hàng thân thiết chính. |
id |
Bắt buộc. Giá trị nhận dạng duy nhất của một đối tượng. Mã nhận dạng này phải là duy nhất trên tất cả các đối tượng của một tổ chức phát hành. Giá trị này phải tuân theo định dạng issuer ID.identifier, trong đó mã nhận dạng trước do Google phát hành và mã nhận dạng sau do bạn chọn. Giá trị nhận dạng duy nhất chỉ được chứa các ký tự chữ và số, dấu chấm ("."), dấu gạch dưới ("_") hoặc dấu gạch ngang ("-"). |
class |
Bắt buộc. Lớp liên kết với đối tượng này. Lớp phải cùng loại với đối tượng này, phải tồn tại và phải được phê duyệt. Mã lớp phải tuân theo định dạng issuer ID.identifier, trong đó mã bưu chính do Google phát hành còn mã sau do bạn chọn. |
version |
Không được dùng nữa |
state |
Bắt buộc. Trạng thái của đối tượng. Trường này dùng để xác định cách hiển thị một đối tượng trong ứng dụng. Ví dụ: đối tượng |
barcode |
Loại và giá trị mã vạch. |
messages[] |
Một mảng thông báo hiển thị trong ứng dụng. Tất cả người dùng của đối tượng này sẽ nhận được thông báo liên quan. Số lượng tối đa của các trường này là 10. |
valid |
Khoảng thời gian đối tượng này sẽ là |
locations[] |
Lưu ý: Trường này hiện không được hỗ trợ để kích hoạt thông báo theo vị trí địa lý. |
has |
Cho biết đối tượng có người dùng hay không. Trường này do nền tảng đặt. |
smart |
Giá trị sẽ được truyền đến thiết bị đầu cuối được chứng nhận Smart Tap qua NFC cho đối tượng này. Bạn cũng phải thiết lập đúng cách các trường cấp lớp Nếu bạn không đặt giá trị này nhưng các trường cấp lớp |
has |
Liệu đối tượng này có đang được liên kết với một thiết bị hay không. Trường này do nền tảng đặt khi người dùng lưu đối tượng, liên kết đối tượng đó với thiết bị của họ. Dành cho một số đối tác chọn lọc sử dụng. Hãy liên hệ với nhóm hỗ trợ để biết thêm thông tin. |
disable |
Cho biết liệu thông báo có bị chặn rõ ràng hay không. Nếu bạn đặt trường này thành true, thì thông báo hết hạn cho người dùng sẽ bị chặn, bất kể trường Hiện tại, bạn chỉ có thể đặt giá trị này cho các mặt hàng. |
info |
Không dùng nữa. Thay vào đó, hãy sử dụng textModulesData. |
image |
Dữ liệu mô-đun hình ảnh. Số lượng tối đa của các trường này hiển thị là 1 từ cấp đối tượng và 1 cho cấp đối tượng lớp. |
text |
Dữ liệu mô-đun văn bản. Nếu dữ liệu mô-đun văn bản cũng được xác định trên lớp này, thì cả hai đều sẽ hiển thị. Số lượng tối đa của các trường này hiển thị là 10 từ đối tượng và 10 từ lớp. |
links |
Liên kết dữ liệu mô-đun. Nếu dữ liệu mô-đun đường liên kết cũng được xác định trên lớp, thì cả hai sẽ hiển thị. |
app |
Đường liên kết đến trang web hoặc ứng dụng (không bắt buộc) sẽ xuất hiện dưới dạng một nút ở mặt trước của thẻ và vé. Nếu bạn cung cấp AppLinkData cho đối tượng lớp tương ứng, thì chỉ đối tượng AppLinkData mới hiển thị. |
rotating |
Loại và giá trị mã vạch xoay. |
hero |
Ảnh biểu ngữ không bắt buộc xuất hiện ở mặt trước của thẻ. Nếu không có lớp nào, hình ảnh chính của lớp (nếu có) sẽ xuất hiện. Nếu cũng không có hình ảnh chính của lớp, thì sẽ không có nội dung nào hiển thị. |
grouping |
Thông tin kiểm soát cách nhóm thẻ và vé lại với nhau. |
pass |
Truyền các quy tắc ràng buộc cho đối tượng. Bao gồm cả việc hạn chế hành vi NFC và ảnh chụp màn hình. |
save |
Các quy định hạn chế đối với đối tượng cần được xác minh trước khi người dùng cố gắng lưu thẻ và vé. Xin lưu ý rằng quy định hạn chế này sẽ chỉ được áp dụng trong thời gian tiết kiệm pin. Nếu các quy định hạn chế thay đổi sau khi người dùng lưu thẻ và vé, thì các quy định hạn chế mới sẽ không được áp dụng cho thẻ và vé đã lưu. |
linked |
linkedObjectIds là danh sách các đối tượng khác như vé xem sự kiện, thẻ khách hàng thân thiết, ưu đãi, chung, thẻ quà tặng, thẻ đi phương tiện công cộng và thẻ lên máy bay sẽ tự động được đính kèm vào đối tượng thẻ khách hàng thân thiết này. Nếu người dùng đã lưu thẻ khách hàng thân thiết này, thì các linkedObjectIds này sẽ tự động được chuyển vào ví của người dùng (trừ phi họ tắt chế độ cài đặt để nhận những thẻ và vé được liên kết đó). Đảm bảo rằng các đối tượng có trong linkedObjectIds đã được chèn – nếu không, các lệnh gọi sẽ không thành công. Sau khi liên kết, bạn không thể huỷ liên kết các đối tượng đã liên kết. Bạn không thể liên kết các đối tượng thuộc về một tổ chức phát hành khác. Có giới hạn về số lượng đối tượng có thể được liên kết với một đối tượng. Sau khi đạt đến giới hạn, các đối tượng liên kết mới trong lệnh gọi sẽ bị bỏ qua một cách tự động. Mã đối tượng phải tuân theo định dạng issuer ID.identifier, trong đó mã nhận dạng trước do Google phát hành và mã nhận dạng sau do bạn chọn. |
notify |
Liệu nội dung cập nhật trường cho đối tượng này có kích hoạt thông báo hay không. Khi được đặt thành NOTIFY, chúng tôi sẽ cố gắng kích hoạt thông báo cập nhật trường cho người dùng. Những thông báo này sẽ chỉ được gửi đến người dùng nếu trường đó nằm trong danh sách cho phép. Nếu bạn đặt thành DO_NOT_NOTIFY hoặc NOTIFICATION_SETTINGS_UNSPECIFIED, thì hệ thống sẽ không kích hoạt thông báo nào. Chế độ cài đặt này là tạm thời và cần được đặt với mỗi yêu cầu PATCH hoặc UPDATE, nếu không thông báo sẽ không được kích hoạt. |
value |
Dữ liệu mô-đun giá trị gia tăng không bắt buộc. Tối đa 10 đối tượng. |
LoyaltyPoints
Biểu diễn dưới dạng JSON |
---|
{ "label": string, "balance": { object ( |
Trường | |
---|---|
label |
Nhãn điểm khách hàng thân thiết, chẳng hạn như "Điểm". Độ dài tối đa nên dùng là 9 ký tự. |
balance |
Số điểm khách hàng thân thiết của chủ tài khoản, chẳng hạn như "500" hoặc "10.000 VND". Độ dài tối đa đề xuất là 7 ký tự. Đây là trường bắt buộc của |
localized |
Chuỗi đã dịch cho nhãn. Độ dài tối đa nên dùng là 9 ký tự. |
LoyaltyPointsBalance
Biểu diễn dưới dạng JSON |
---|
{
"string": string,
"int": integer,
"double": number,
"money": {
object ( |
Trường | |
---|---|
string |
Dạng chuỗi của số dư. Bạn chỉ nên điền một trong các loại phụ sau (chuỗi, int, kép, tiền). |
int |
Dạng số nguyên của số dư. Chỉ nên điền một trong các loại phụ này (string, int, double, money). |
double |
Hình thức kép của số dư. Chỉ nên điền một trong các loại phụ này (string, int, double, money). |
money |
Hình thức tiền của số dư. Chỉ nên điền một trong các loại phụ này (string, int, double, money). |
Phương thức |
|
---|---|
|
Thêm thông báo vào đối tượng khách hàng thân thiết được tham chiếu bằng mã nhận dạng đối tượng đã cho. |
|
Trả về đối tượng khách hàng thân thiết có mã nhận dạng đối tượng đã cho. |
|
Chèn một đối tượng khách hàng thân thiết có mã nhận dạng và thuộc tính đã cho. |
|
Trả về danh sách tất cả các đối tượng khách hàng thân thiết của một mã nhà phát hành cụ thể. |
|
Sửa đổi các đối tượng ưu đãi được liên kết cho đối tượng khách hàng thân thiết có mã nhận dạng đã cho. |
|
Cập nhật đối tượng khách hàng thân thiết được tham chiếu theo mã đối tượng đã cho. |
|
Cập nhật đối tượng khách hàng thân thiết được tham chiếu bằng mã đối tượng đã cho. |