REST Resource: genericobject

{
  "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
  ]
}

enum (GenericType)

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

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

object (LocalizedString)

Nhãn tiêu đề của thẻ và vé, chẳng hạn như vị trí có thể sử dụng thẻ và vé này. 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é.

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

object (Image)

Hình ảnh biểu trưng của thẻ/vé. Hình ảnh này xuất hiện trong chế độ xem chi tiết thẻ ở trên cùng bên trái, cũng như trong chế độ xem danh sách/hình thu nhỏ. Nếu không có biểu trưng, chữ cái đầu tiên của cardTitle sẽ hiển thị dưới dạng biểu trưng.

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.

object (Notifications)

Chế độ cài đặt thông báo được bật cho đối tượng này.

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

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.

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

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

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.

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.

object (TextModuleData)

Dữ liệu mô-đun văn bản. Nếu textModulesData cũng được khai báo trên lớp này, cả hai đều 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.

object (LinksModuleData)

Liên kết dữ liệu mô-đun. Nếu linksModuleData 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.

object (AppLinkData)

Đường liên kết đến ứng dụng hoặc trang web (không bắt buộc) sẽ hiển thị dưới dạng nút ở mặt trước của thẻ và vé. Nếu AppLinkData được cung cấp cho lớp tương ứng thì chỉ có đối tượng AppLinkData sẽ xuất hiện.

object (GroupingInfo)

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

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ợ các ký tự ASCII.

object (RotatingBarcode)

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

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.

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.

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 các thông báo liên quan. Số lượng tối đa các trường này là 10.

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.

object (Image)

Biểu trưng rộng của thẻ/vé. Khi được cung cấp, hình ảnh này sẽ được dùng thay cho biểu trưng ở góc trên cùng bên trái của chế độ xem thẻ.

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.

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.

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 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 như vậy).

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

{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}

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.

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.

{
  "enableNotification": boolean
}

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.

{
  "enableNotification": boolean
}

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.