REST Resource: loyaltyobject

{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

string

Xác định loại tài nguyên này. Giá trị: chuỗi cố định "walletobjects#loyaltyObject".

object (LoyaltyClass)

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.

string

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 đề xuất là 20 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên màn hình nhỏ hơn.

string

Giá trị nhận dạng tài khoản khách hàng thân thiết. Độ dài tối đa được đề xuất là 20 ký tự.

object (LoyaltyPoints)

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.

string

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.

object (LoyaltyPoints)

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.

string

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 công ty phát hành. Giá trị này 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. 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 ("-").

string

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 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.

string (int64 format)

Không được dùng nữa

enum (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 inactive được chuyển sang phần "Thẻ và vé đã hết hạn".

object (Barcode)

Loại và giá trị mã vạch.

object (Message)

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.

object (TimeInterval)

Khoảng thời gian đối tượng này sẽ là active và đối tượng có thể được sử dụng. Trạng thái của đối tượng sẽ được thay đổi thành expired khi khoảng thời gian này đã trôi qua.

object (LatLongPoint)

Lưu ý: Trường này hiện không được hỗ trợ để kích hoạt thông báo theo vị trí.

boolean

Cho biết đối tượng có người dùng hay không. Trường này do nền tảng đặt.

string

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 enableSmartTap và redemptionIssuers để thẻ và vé hỗ trợ tính năng Chạm thông minh. Chỉ hỗ trợ các ký tự ASCII.

Nếu bạn không đặt giá trị này nhưng các trường cấp lớp enableSmartTap và redemptionIssuers được thiết lập đúng cách, thì các trường barcode.value hoặc accountId sẽ được dùng làm trường dự phòng (nếu có).

boolean

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. Hãy liên hệ với nhóm hỗ trợ để biết thêm thông tin.

boolean

Cho biết liệu có cần chặn thông báo một cách rõ ràng hay không. Nếu bạn đặt trường này thành true, bất kể trường messages là gì, thông báo hết hạn cho người dùng sẽ bị chặn. Theo mặc định, trường này được đặt thành false.

Hiện tại, bạn chỉ có thể thiết lập chế độ cài đặt này cho các mặt hàng.

object (InfoModuleData)

Không dùng nữa. Thay vào đó, hãy sử dụng textModulesData.

object (ImageModuleData)

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.

object (TextModuleData)

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, thì cả hai sẽ hiển thị. Số lượng tối đa các trường này được hiển thị là 10 trường từ đối tượng và 10 trường từ lớp.

object (LinksModuleData)

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ị.

object (AppLinkData)

Đường liên kết đến ứng dụng hoặc trang web (không bắt buộc) sẽ hiển thị dưới dạng nút ở mặt trước của thẻ và vé. Nếu AppLinkData được cung cấp cho lớp tương ứng thì chỉ có đối tượng AppLinkData sẽ xuất hiện.

object (RotatingBarcode)

Loại và giá trị mã vạch xoay.

object (Image)

Hình ảnh biểu ngữ không bắt buộc xuất hiện ở mặt trước thẻ. Nếu không có hình ảnh nào, hình ảnh chính của lớp (nếu có) sẽ xuất hiện. Nếu hình ảnh chính của lớp học cũng không có, thì sẽ không có nội dung nào xuất hiện.

object (GroupingInfo)

Thông tin kiểm soát cách nhóm thẻ và vé lại với nhau.

object (PassConstraints)

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.

object (SaveRestrictions)

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 các hạn chế này sẽ chỉ áp dụng trong thời gian lưu. 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 hạn chế mới sẽ không áp dụng cho một thẻ và vé đã lưu.

string

linkObjectIds là danh sách các đối tượng khác như vé xem sự kiện, chương trình khách hàng thân thiết, ưu đãi, thông tin chung, thẻ quà tặng, thẻ đi phương tiện công cộng và thẻ lên máy bay sẽ được tự động thêm vào đối tượng 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 linkedObjectId này sẽ tự động được đẩy vào ví của người dùng (trừ phi họ tắt chế độ cài đặt để nhận các thẻ và vé được liên kết như vậy).

Đả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ề nhà 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.

enum (NotificationSettingsForUpdates)

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. Chúng tôi sẽ chỉ gửi các thông báo này cho người dùng nếu trường này 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.

object (ValueAddedModuleData)

Dữ liệu mô-đun giá trị gia tăng không bắt buộc. Tối đa 10 đối tượng.

{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}

string

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ự.

object (LoyaltyPointsBalance)

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 loyaltyPoints và secondaryLoyaltyPoints.

object (LocalizedString)

Chuỗi đã dịch cho nhãn. Độ dài tối đa đề xuất là 9 ký tự.

{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}

string

Dạng chuỗi của số dư. Chỉ nên điền một trong các loại phụ này (string, int, double, money).

integer

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).

number

Dạng số dư. Chỉ nên điền một trong các loại phụ này (string, int, double, money).

object (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).