REST Resource: giftcardobject

Tài nguyên: GiftCardObject

Biểu diễn dưới dạng JSON
{
  "kind": string,
  "classReference": {
    object (GiftCardClass)
  },
  "cardNumber": string,
  "pin": string,
  "balance": {
    object (Money)
  },
  "balanceUpdateTime": {
    object (DateTime)
  },
  "eventNumber": string,
  "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)
    }
  ]
}
Trường
kind
(deprecated)

string

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

classReference

object (GiftCardClass)

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.

cardNumber

string

Bắt buộc. Số của thẻ.

pin

string

Mã PIN của thẻ.

balance

object (Money)

Số dư bằng tiền của thẻ.

balanceUpdateTime

object (DateTime)

Ngày và giờ gần đây nhất số dư được cập nhật.

Bạn phải nhập độ dời.

Nếu bạn cập nhật số dư và không cung cấp thuộc tính này, thì hệ thống sẽ đặt mặc định là thời gian hiện tại.

eventNumber

string

Số sự kiện của thẻ, một trường không bắt buộc mà một số thẻ quà tặng sử dụng.

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 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ã 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 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 này 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 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.

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

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ủ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à đố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.

locations[]
(deprecated)

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

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 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 đúng cách các trường cấp lớp enableSmartTapredemptionIssuers để thẻ và vé hỗ trợ tính năng Chạm thông minh. Chỉ hỗ trợ các ký tự ASCII.

hasLinkedDevice

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.

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

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

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

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

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 cả 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 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 quy định hạn chế mới sẽ không được áp dụng cho thẻ và vé đã lưu.

linkedObjectIds[]

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 thẻ quà tặng này. Nếu người dùng đã lưu thẻ quà tặng 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 đó).

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

notifyPreference

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

valueAddedModuleData[]

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 trên đối tượng.

Phương thức

addmessage

Thêm thông báo vào đối tượng thẻ quà tặng được tham chiếu bằng mã nhận dạng đối tượng đã cho.

get

Trả về đối tượng thẻ quà tặng có mã đối tượng đã cho.

insert

Chèn một đối tượng thẻ quà tặng có mã nhận dạng và thuộc tính đã cho.

list

Trả về danh sách tất cả đối tượng thẻ quà tặng cho một mã nhận dạng người phát hành nhất định.

patch

Cập nhật đối tượng thẻ quà tặng được tham chiếu theo mã đối tượng đã cho.

update

Cập nhật đối tượng thẻ quà tặng được tham chiếu theo mã đối tượng đã cho.