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,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
Trường
genericType

enum (GenericType)

Chỉ định thẻ này thuộc GenericType nào.

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ư "XXX Phòng tập thể dục", "Bảo hiểm AAA". Trường này là bắt buộc và xuất hiện trong hàng tiêu đề ở phía trên cùng của thẻ.

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 của thẻ và vé.

header

object (LocalizedString)

Bắt buộc. Tiêu đề 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 thông tin chi tiết về thẻ và vé.

hexBackgroundColor

string

Màu nền cho thẻ. Nếu bạn không đặt chính sách này, 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, thì màu chủ đạo của biểu trưng sẽ được sử dụng. Nếu bạn không đặt biểu trưng, Google sẽ chọn màu chủ đạo.

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 công ty 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 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 issuerID.identifier, trong đó issuerID là do Google phát hành và identifier là do bạn chọn.

barcode

object (Barcode)

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

heroImage

object (Image)

Ả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ị với chiều rộng 100%.

validTimeInterval

object (TimeInterval)

Khoảng thời gian mà đối tượng này sẽ đượ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 số các hình ảnh ở cấp lớp và một hình ảnh ở 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 định nghĩa trên lớp này, 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ừ lớp và 10 trường 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 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 enableSmartTapredemptionIssuers để thẻ/vé hỗ trợ công nghệ Chạm thông minh. Chỉ hỗ trợ ký tự ASCII.

rotatingBarcode

object (RotatingBarcode)

Chế độ cài đặt/chi tiết mã vạch xoay.

state

enum (State)

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" . Nếu bạn không cung cấp thuộc tính 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.

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.

GenericType

Loại thẻ chung.

Enum
GENERIC_TYPE_UNSPECIFIED Loại chung không được chỉ đị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ửa
GENERIC_RECEIPT Biên nhận
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 thông báo Hết hạn/Thông báo sắp tới. 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)

Một thông báo sẽ được kích hoạt 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 tổ chức phát hành muốn Google Wallet gửi thông báo về thời gian 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 tổ chức phát hành muốn Google Wallet gửi thông báo về tính hợp lệ của thẻ sắp tới 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ã đối tượng đã cho.

insert

Chèn một đối tượng chung 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 chung cho một mã nhà 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.