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

accountName

string

Tên chủ tài khoản khách hàng thân thiết, chẳng hạn như "John Smith". Bạn nên sử dụng độ dài tối đa là 20 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên 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 đề xuất là 20 ký tự.

loyaltyPoints

object (LoyaltyPoints)

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

linkedOfferIds[]

string

Danh sách các đối tượng ưu đãi 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 của mặt hàng phải theo định dạng issuer ID.identifier, trong đó mã do Google phát hành và mã sau do bạn chọn.

secondaryLoyaltyPoints

object (LoyaltyPoints)

Nhãn, số dư và loại điểm phần thưởng khách hàng thân thiết phụ. Hiển thị cùng với các đ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à mã duy nhất trên tất cả các đối tượng của một nhà phát hành. Giá trị này phải tuân theo định dạng issuer ID.identifier, trong đó mã do Google phát hành và 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 thuộc 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ã do Google phát hành và 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 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 đến mục "Thẻ và vé đã hết hạn".

barcode

object (Barcode)

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

messages[]

object (Message)

Một dãy thông báo hiển thị trong ứng dụng. Tất cả người dùng đối tượng này sẽ nhận được các tin nhắn liên quan. Số lượng tối đa của các trường này là 10.

validTimeInterval

object (TimeInterval)

Khoảng thời gian mà đối tượng này sẽ là active và có thể sử dụng đối tượng. 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 địa lý.

hasUsers

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.

smartTapRedemptionValue

string

Giá trị sẽ được truyền đến thiết bị đầu cuối được chứng nhận Chạm thông minh qua NFC cho đối tượng này. Bạn cũng phải thiết lập các trường cấp lớp enableSmartTapredemptionIssuers đúng cách để thẻ/vé hỗ trợ tính năng Chạm thông minh. Chỉ hỗ trợ các ký tự ASCII.

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

hasLinkedDevice

boolean

Liệu đối tượng này hiện có được liên kết với một thiết bị duy nhất hay không. Trường này do nền tảng đặt khi người dùng lưu đối tượng và liên kết đối tượng đó với thiết bị của họ. Chỉ 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.

disableExpirationNotification

boolean

Cho biết liệu thông báo có phải bị chặn một cách rõ ràng hay không. Nếu bạn đặt trường này thành true (đúng), thì thông báo về thời hạn gửi đến người dùng đều 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 mục này cho ưu đãi.

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

rotatingBarcode

object (RotatingBarcode)

Loại và giá trị 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, thì hình ảnh chính của lớp (nếu có) sẽ hiển thị. Nếu cũng không có hình ảnh chính của lớp thì sẽ không có hình ảnh nào hiển thị.

groupingInfo

object (GroupingInfo)

Thông tin kiểm soát cách nhóm các 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 cả việc giới hạn NFC và hành vi chụp ảnh màn hình.

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

localizedLabel

object (LocalizedString)

Các chuỗi đã được dịch cho nhãn. Độ dài tối đa đề xuất 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ỉ được điền một trong các loại phụ này (string, int, double, tiền).

int

integer

Dạng số nguyên của số dư. Bạn chỉ được điền một trong các loại phụ này (string, int, double, tiền).

double

number

Dạng thức kép của số dư. Bạn chỉ được điền một trong các loại phụ này (string, int, double, tiền).

money

object (Money)

Dạng tiền tệ của số dư. Bạn chỉ được điền một trong các loại phụ này (string, int, double, tiền).

Phương thức

addmessage

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

get

Trả về đối tượng khách hàng thân thiết có mã đối tượng đã cho.

insert

Chèn một đối tượng chương trình khách hàng thân thiết cùng với 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 trong chương trình khách hàng thân thiết của một mã nhà phát hành nhất định.

modifylinkedofferobjects

Sửa đổi các đối tượng mặt hàng được liên kết cho đối tượng chương trình 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.