REST Resource: genericobject

Tài nguyên: GenericObject

Đối tượng chung

Biểu diễn dưới dạng JSON 
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
Trường
genericType

enum (GenericType)

Chỉ định GenericType mà thẻ thuộc về.
cardTitle

object (LocalizedString)

Bắt buộc. Tiêu đề của thẻ/vé. Đây thường là Tên doanh nghiệp, chẳng hạn như "Phòng tập thể dục XXX", "Bảo hiểm AAA". Đây là trường bắt buộc và xuất hiện trong hàng tiêu đề ở đầu thẻ và vé.
subheader

object (LocalizedString)

Nhãn tiêu đề của thẻ và vé, chẳng hạn như vị trí nơi thẻ/vé này có thể được sử dụng. Xuất hiện ngay phía trên tiêu đề trong hàng tiêu đề trong chế độ xem chi tiết thẻ và vé.
header

object (LocalizedString)

Bắt buộc. Tên của thẻ và vé, chẳng hạn như "Phiếu giảm giá 50%" hoặc "Thẻ thư viện" hoặc "Phiếu thưởng". Đây là trường bắt buộc và xuất hiện trong hàng tiêu đề của chế độ xem chi tiết thẻ và vé.
hexBackgroundColor

string

Màu nền cho thẻ. Nếu bạn không đặt, hệ thống sẽ sử dụng màu chủ đạo của hình ảnh chính. Nếu bạn không đặt hình ảnh chính, hệ thống sẽ sử dụng màu chủ đạo của biểu trưng. Nếu bạn không đặt biểu trưng, Google sẽ chọn một màu.
notifications

object (Notifications)

Chế độ cài đặt thông báo được bật cho đối tượng này.
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 tổ chức phát hành. Giá trị này phải tuân theo định dạng issuerID.identifier, trong đó issuerID do Google phát hành và identifier là do bạn chọn. Giá trị nhận dạng duy nhất chỉ có thể bao gồm các 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 tuân theo định dạng issuerID.identifier, trong đó issuerID do Google phát hành và identifier do bạn chọn.
barcode

object (Barcode)

Loại và giá trị mã vạch. Nếu thẻ và vé không có mã vạch, chúng ta có thể cho phép bên phát hành thiết lập Barcode.alternate_text và chỉ hiển thị mã đó.
heroImage

object (Image)

Hình ảnh biểu ngữ xuất hiện ở mặt trước của thẻ (nếu có). Hình ảnh sẽ hiển thị ở chiều rộng 100%.
validTimeInterval

object (TimeInterval)

Khoảng thời gian mà đối tượng này được coi là hợp lệ hoặc có thể sử dụng. Khi khoảng thời gian này trôi qua, đối tượng sẽ được coi là đã hết hạn. Điều này sẽ ảnh hưởng đến việc hiển thị trên thiết bị của người dùng.
imageModulesData[]

object (ImageModuleData)

Dữ liệu mô-đun hình ảnh. Chỉ một trong hai hình ảnh từ lớp và một hình ảnh từ cấp đối tượng sẽ được kết xuất khi cả hai được đặt.
textModulesData[]

object (TextModuleData)

Dữ liệu mô-đun văn bản. Nếu textModulesData cũng được xác định trên lớp, cả hai sẽ hiển thị. Số lượng tối đa của các trường này hiển thị là 10 từ lớp và 10 từ đối tượng.
groupingInfo

object (GroupingInfo)

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

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

object (RotatingBarcode)

Chế độ cài đặt/thông tin chi tiết về mã vạch xoay.
state

enum (State)

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". Nếu bạn không cung cấp giá trị này, đối tượng sẽ được coi là ACTIVE.
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.
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.
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 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.
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.
linkedObjectIds[]

string

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 chung này. Nếu người dùng đã lưu thẻ chung 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ề 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.

GenericType

Loại thẻ chung.

Enum
GENERIC_TYPE_UNSPECIFIED Loại chung không xác định.
GENERIC_SEASON_PASS Vé xem theo mùa
GENERIC_UTILITY_BILLS Hoá đơn dịch vụ tiện ích
GENERIC_PARKING_PASS Thẻ đỗ xe
GENERIC_VOUCHER Phiếu thưởng
GENERIC_GYM_MEMBERSHIP Thẻ thành viên phòng tập thể dục
GENERIC_LIBRARY_MEMBERSHIP Thẻ thành viên thư viện
GENERIC_RESERVATIONS Đặt chỗ
GENERIC_AUTO_INSURANCE Thẻ bảo hiểm ô tô
GENERIC_HOME_INSURANCE Thẻ bảo hiểm nhà ở
GENERIC_ENTRY_TICKET Vé vào cổng
GENERIC_RECEIPT Biên nhận
GENERIC_LOYALTY_CARD Thẻ khách hàng thân thiết. Xin lưu ý rằng bạn nên sử dụng loại thẻ và vé dành riêng cho Thẻ khách hàng thân thiết thay vì loại chung này. Loại thẻ và vé khách hàng thân thiết chuyên dụng cung cấp nhiều tính năng và chức năng hơn so với loại thẻ và vé chung.
GENERIC_OTHER Loại khác

Thông báo

Cho biết liệu đối tượng có cần bật thông báo hay không. Chúng tôi chỉ hỗ trợ một trong hai loại ExpiryNotification/UpcomingNotification. expiryNotification được ưu tiên hơn upcomingNotification. Nói cách khác, nếu bạn đặt expiryNotification, chúng ta sẽ bỏ qua trường upcomingNotification.

Biểu diễn dưới dạng JSON 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
Trường
expiryNotification

object (ExpiryNotification)

Hệ thống sẽ kích hoạt thông báo vào một thời điểm cụ thể trước khi thẻ hết hạn.
upcomingNotification

object (UpcomingNotification)

Hệ thống sẽ kích hoạt thông báo vào một thời điểm cụ thể trước khi thẻ có thể sử dụng được.

ExpiryNotification

Cho biết rằng nhà phát hành muốn Google Wallet gửi thông báo hết hạn 2 ngày trước khi thẻ hết hạn.

Biểu diễn dưới dạng JSON 
{
  "enableNotification": boolean
}
Trường
enableNotification

boolean

Cho biết liệu đối tượng có cần bật thông báo hết hạn hay không.

UpcomingNotification

Cho biết rằng nhà phát hành muốn Google Wallet gửi thông báo về ngày hết hạn sắp tới của thẻ 1 ngày trước khi thẻ có hiệu lực/có thể sử dụng.

Biểu diễn dưới dạng JSON 
{
  "enableNotification": boolean
}
Trường
enableNotification

boolean

Cho biết liệu đối tượng có cần bật thông báo sắp tới hay không.

Phương thức

addmessage

 Thêm thông báo vào đối tượng chung được tham chiếu theo mã đối tượng đã cho.

get

 Trả về đối tượng chung có mã nhận dạng đối tượng đã cho.

insert

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

list

 Trả về danh sách tất cả đối tượng chung cho một mã nhận dạng của tổ chức phát hành nhất định.

patch

 Cập nhật đối tượng chung được tham chiếu theo mã đối tượng đã cho.

update

 Cập nhật đối tượng chung được tham chiếu theo mã đối tượng đã cho.