REST Resource: loyaltyobject

Tài nguyên: LoyaltyObject

Biểu diễn dưới dạng JSON 
{
  "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)
  }
}
Trường
kind
(deprecated)

string

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

object (LoyaltyClass)

Bản sao 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.
accountName

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 đượ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.
accountId

string

Mã 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ự.
loyaltyPoints

object (LoyaltyPoints)

Nhãn, số dư và loại điểm phần thưởng dành cho khách hàng thân thiết.
linkedOfferIds[]

string

Danh sách các đối tượng ưu đãi được liên kết với thẻ khách hàng thân thiết này. Đối tượng ưu đãi phải tồn tại.

Mã đối tượng ưu đãi 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.
secondaryLoyaltyPoints

object (LoyaltyPoints)

Nhãn, số dư và loại điểm phần thưởng dành cho khách hàng thân thiết phụ. Được hiển thị ngoài điểm khách hàng thân thiết chính.
id

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 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 bao gồm ký tự chữ-số, ".", "_" hoặc "-".
classId

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.
version
(deprecated)

string (int64 format)

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

enum (State)

Bắt buộc. Trạng thái của đối tượng. Trường này được dùng để xác định cách một đối tượng xuất hiện trong ứng dụng. Ví dụ: một đối tượng inactive được di chuyển sang "Thẻ và vé đã hết hạn" .
barcode

object (Barcode)

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

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ác trường này là 10.
validTimeInterval

object (TimeInterval)

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

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í địa lý.
hasUsers

boolean

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

string

Giá trị sẽ được truyền đến một thiết bị đầu cuối được chứng nhận bằng tính năng Chạm thông minh qua NFC đối với vật thể này. Bạn cũng phải thiết lập chính xác các trường cấp lớp enableSmartTap và redemptionIssuers để thẻ/vé hỗ trợ công nghệ Chạm thông minh. Chỉ hỗ trợ 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ó).
hasLinkedDevice

boolean

Liệu đối tượng này hiện có liên kết với một thiết bị nào 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.
disableExpirationNotification

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, thì thông báo hết hạn cho người dùng sẽ bị chặn, bất kể trường messages là gì. Theo mặc định, trường này được đặt thành false.

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

object (InfoModuleData)

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

object (ImageModuleData)

Dữ liệu mô-đun hình ảnh. Số lượng trường tối đa được hiển thị là 1 trường ở cấp đối tượng và 1 trường ở cấp đối tượng lớp.
textModulesData[]

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 này, thì cả hai đều 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.
rotatingBarcode

object (RotatingBarcode)

Giá trị và loại mã vạch xoay vòng.
heroImage

object (Image)

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

object (GroupingInfo)

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

object (PassConstraints)

Truyền các quy tắc ràng buộc cho đối tượng. Bao gồm việc hạn chế hành vi NFC và ảnh chụp màn hình.
saveRestrictions

object (SaveRestrictions)

Các 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 tiết kiệm. 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.

LoyaltyPoints

Biểu diễn dưới dạng JSON 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
Trường
label

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

object (LoyaltyPointsBalance)

Số dư đ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". Độ dài tối đa được đề xuất là 7 ký tự. Đây là trường bắt buộc của loyaltyPoints và secondaryLoyaltyPoints.
localizedLabel

object (LocalizedString)

Các chuỗi được 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 (Money)
  }
}
Trường
string

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

integer

Dạng số nguyên 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).
double

number

Dạng 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).
money

object (Money)

Hình thức tiền 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).

Phương thức

addmessage

 Thêm thông báo vào đối tượng khách hàng thân thiết được tham chiếu theo mã đối tượng đã cho.

get

 Trả về đối tượng mức độ trung thành có mã đối tượng đã cho.

insert

 Chèn một đối tượng khách hàng thân thiết có mã nhận dạng và các thuộc tính đã cho.

list

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

modifylinkedofferobjects

 Sửa đổi đối tượng ưu đãi được liên kết cho đối tượng khách hàng thân thiết bằng mã nhận dạng đã cho.

patch

 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.

update

 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.