REST Resource: loyaltyclass

{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}

string

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

string

Bắt buộc. Tên chương trình, chẳng hạn như "Trang phục của Adam". Ứng dụng có thể cho thấy dấu ba chấm sau 20 ký tự đầu tiên để đảm bảo chuỗi đầy đủ sẽ hiện trên những màn hình nhỏ hơn.

object (Image)

Bắt buộc. Biểu trưng của chương trình khách hàng thân thiết hoặc công ty. Biểu trưng này xuất hiện trong cả chế độ xem chi tiết và chế độ xem danh sách của ứng dụng.

string

Nhãn tên tài khoản, chẳng hạn như "Tên thành viên". Độ dài tối đa được đề xuất là 15 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các màn hình nhỏ hơn.

string

Nhãn mã tài khoản, chẳng hạn như "Mã thành viên". Độ dài tối đa được đề xuất là 15 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các màn hình nhỏ hơn.

string

Nhãn cấp phần thưởng, chẳng hạn như "Cấp phần thưởng". Độ dài tối đa nên dùng là 9 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các màn hình nhỏ hơn.

string

Cấp phần thưởng, chẳng hạn như "Vàng" hoặc "Bạch kim". Độ dài tối đa được đề xuất là 7 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các màn hình nhỏ hơn.

object (LocalizedString)

Các chuỗi được dịch cho programName. Ứng dụng có thể cho thấy dấu ba chấm sau 20 ký tự đầu tiên để đảm bảo chuỗi đầy đủ sẽ hiện trên những màn hình nhỏ hơn.

object (LocalizedString)

Các chuỗi được dịch cho accountNameLabel. Độ dài tối đa được đề xuất là 15 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các màn hình nhỏ hơn.

object (LocalizedString)

Các chuỗi được dịch cho accountIdLabel. Độ dài tối đa được đề xuất là 15 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các màn hình nhỏ hơn.

object (LocalizedString)

Các chuỗi được dịch cho creatorTierLabel. Độ dài tối đa nên dùng là 9 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các màn hình nhỏ hơn.

object (LocalizedString)

Các chuỗi được dịch cho RewardsTier. Độ dài tối đa được đề xuất là 7 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các màn hình nhỏ hơn.

string

Nhãn cấp phần thưởng phụ, chẳng hạn như "Cấp phần thưởng".

object (LocalizedString)

Các chuỗi được dịch cho phụRewardsTierLabel.

string

Cấp phần thưởng phụ, chẳng hạn như "Vàng" hoặc "Bạch kim".

object (LocalizedString)

Các chuỗi được dịch cho bậc phụRewardsTier.

object (DiscoverableProgram)

Thông tin về cách khám phá và tạo thực thể của lớp này trong ứng dụng Google Pay.

object (ClassTemplateInfo)

Thông tin mẫu về cách lớp học sẽ hiển thị. Nếu bạn không đặt chính sách này, Google sẽ chuyển dự phòng về nhóm trường mặc định để hiển thị.

string

Bắt buộc. Giá trị nhận dạng duy nhất của một lớp. Mã này không được trùng với tất cả các hạng của công ty phát hành. Giá trị này phải tuân theo định dạng issuer ID.identifier, trong đó mã bưu chính do Google phát hành còn mã sau do bạn chọn. Giá trị nhận dạng duy nhất của bạn chỉ được bao gồm ký tự chữ-số, ".", "_" hoặc "-".

string (int64 format)

Không được dùng nữa

string

Bắt buộc. Tên nhà phát hành. Độ dài tối đa được đề xuất là 20 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các màn hình nhỏ hơn.

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ác trường này là 10.

boolean

Không dùng nữa. Thay vào đó, hãy sử dụng multipleDevicesAndHoldersAllowedStatus.

object (Uri)

URI trang chủ ứng dụng của bạn. Việc điền sẵn URI trong trường này sẽ dẫn đến hành vi chính xác tương tự như điền URI trong linksModuleData (khi một đối tượng được kết xuất, một đường liên kết đến trang chủ sẽ xuất hiện ở phần thường được coi là phần linksModuleData của đối tượng).

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í địa lý.

enum (ReviewStatus)

Bắt buộc. Trạng thái của lớp học. Bạn có thể đặt trường này thành draft hoặc underReview bằng cách sử dụng lệnh gọi API chèn, vá hoặc cập nhật. Khi đã thay đổi trạng thái xem xét từ draft, bạn sẽ không thể khôi phục trạng thái đó về draft.

Bạn nên giữ trường này thành draft khi lớp đang trong quá trình phát triển. Không thể dùng lớp draft để tạo đối tượng.

Bạn nên thiết lập trường này thành underReview khi cho rằng lớp đã sẵn sàng để sử dụng. Nền tảng sẽ tự động đặt trường này thành approved và trường này có thể được dùng ngay để tạo hoặc di chuyển đối tượng.

Khi cập nhật một lớp đã có approved, bạn nên tiếp tục thiết lập trường này thành underReview.

object (Review)

Các bình luận đánh giá do nền tảng đặt khi một lớp được đánh dấu là approved hoặc rejected.

object (InfoModuleData)

Không dùng nữa. Thay vào đó, hãy sử dụng textModulesData.

object (ImageModuleData)

Dữ liệu mô-đun hình ảnh. Số lượng trường tối đa được hiển thị là 1 trường ở cấp đối tượng và 1 trường ở cấp đối tượng lớp.

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 này, thì 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ừ đối tượng và 10 trường từ lớp.

object (LinksModuleData)

Liên kết dữ liệu mô-đun. Nếu dữ liệu mô-đun liên kết cũng được xác định trên đối tượng, thì cả hai đều sẽ hiển thị.

string (int64 format)

Xác định những tổ chức phát hành chương trình đổi thưởng có thể sử dụng thẻ/vé qua tính năng Chạm thông minh. Công ty phát hành ưu đãi đổi thưởng được xác định theo mã tổ chức phát hành của họ. Tổ chức phát hành ưu đãi phải thiết lập ít nhất một khoá Chạm thông minh.

Bạn cũng phải thiết lập đúng cách các trường enableSmartTap và một trong các trường mã đối tượng smartTapRedemptionValue, mã vạch.value, oraccountId để nhận thẻ và vé có thể hỗ trợ cử chỉ Chạm thông minh.

string

Mã quốc gia dùng để hiển thị quốc gia của thẻ (khi người dùng không ở quốc gia đó) cũng như để hiển thị nội dung được bản địa hoá khi không có nội dung bằng ngôn ngữ của người dùng.

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ó dải ô, thì sẽ không có tệp nào hiển thị. Hình ảnh sẽ hiển thị với chiều rộng 100%.

object (Image)

Không dùng nữa.

boolean

Xác định xem lớp này có hỗ trợ công nghệ Chạm thông minh hay không. Bạn cũng phải thiết lập đúng cách các trường redemptionIssuers và một trong các trường mã đối tượng smartTapRedemptionLevel, mã vạch.value, or accountId để nhận thẻ và vé có thể hỗ trợ cử chỉ Chạm thông minh.

string

Màu nền cho thẻ. Nếu bạn không đặt màu chủ đạo của hình ảnh chính, và 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. Định dạng là #rrggbb, trong đó rrggbb là bộ ba màu hex RGB, chẳng hạn như #ffcc00. Bạn cũng có thể sử dụng phiên bản viết tắt của bộ ba RGB là #rgb, chẳng hạn như #fc0.

object (LocalizedString)

Các chuỗi đã được dịch cho providerName. Độ dài tối đa được đề xuất là 20 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên các màn hình nhỏ hơn.

enum (MultipleDevicesAndHoldersAllowedStatus)

Xác định xem nhiều người dùng và thiết bị có lưu cùng một đối tượng tham chiếu đến lớp này hay không.

object (CallbackOptions)

Các tuỳ chọn gọi lại được dùng để gọi lại công ty phát hành cho mỗi lần người dùng cuối lưu/xoá một đối tượng cho lớp này. Tất cả các đối tượng của lớp này đều đủ điều kiện để thực hiện lệnh gọi lại.

object (SecurityAnimation)

Thông tin không bắt buộc về ảnh động bảo mật. Nếu bạn đặt giá trị này, ảnh động bảo mật sẽ hiển thị trên thông tin chi tiết của thẻ và vé.

enum (ViewUnlockRequirement)

Xem các lựa chọn Yêu cầu mở khoá cho thẻ khách hàng thân thiết.

object (Image)

Biểu trưng rộng của chương trình khách hàng thân thiết hoặc công ty. Khi được cung cấp, tên này sẽ được sử dụng thay cho biểu trưng chương trình ở trên cùng bên trái của chế độ xem thẻ.

object (AppLinkData)

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