REST Resource: offerclass

{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    object (LocalizedString)
  },
  "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),
  "wideTitleImage": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

string

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

string

Bắt buộc. Tiêu đề của ưu đãi, chẳng hạn như "Giảm giá 20% cho mọi loại áo phông". Độ dài tối đa được đề xuất là 60 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên màn hình nhỏ hơn.

enum (RedemptionChannel)

Bắt buộc. Các kênh sử dụng được áp dụng cho ưu đãi này.

string

Bắt buộc. Nhà cung cấp ưu đãi (tên trang web tổng hợp hoặc tên người bán). Độ dài tối đa được đề xuất là 12 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên màn hình nhỏ hơn.

object (Image)

Hình ảnh tiêu đề của ưu đãi. Hình ảnh này hiển thị trong cả chế độ xem chi tiết và chế độ xem danh sách của ứng dụng.

string

Thông tin chi tiết về ưu đãi.

string

Nội dung in nhỏ hoặc điều khoản của ưu đãi, chẳng hạn như "Giảm 20% cho mọi áo phông tại Adam's Apparel".

object (Uri)

Đường liên kết trợ giúp cho ưu đãi, chẳng hạn như http://myownpersonaldomain.com/help

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

Chuỗi đã dịch cho thông tin chi tiết.

object (LocalizedString)

Chuỗi đã dịch cho finePrint.

string

Phiên bản rút gọn của tiêu đề ưu đãi, chẳng hạn như "Giảm giá 20%", được hiển thị cho người dùng để tham khảo nhanh nội dung ưu đãi. Độ dài tối đa được đề xuất là 20 ký tự.

object (LocalizedString)

Các chuỗi được dịch cho tiêu đề ngắn. Độ dài tối đa đề xuất là 20 ký tự.

object (ClassTemplateInfo)

Thông tin mẫu về cách hiển thị lớp. Nếu bạn không đặt giá trị, Google sẽ sử dụng một tập hợp 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ã 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 của bạn chỉ được chứa các ký tự chữ và số, dấu chấm ("."), dấu gạch dưới ("_") hoặc dấu gạch nối ("-").

string (int64 format)

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

string

Bắt buộc. Tên tổ chức 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ủ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 URI vào trường này sẽ dẫn đến hành vi giống hệt như khi điền URI vào linksModuleData (khi một đối tượng được hiển thị, một đường liên kết đến trang chủ sẽ xuất hiện trong 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í.

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 Trạng thái của lớp. 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. Sau khi thay đổi trạng thái xem xét từ draft, bạn không thể thay đổi trạng thái này 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 nào.

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)

Bình luận đánh giá do nền tảng đặt ra 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 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.

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ủa các trường này hiển thị là 10 từ đối tượng và 10 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 đơn vị phát hành có thể sử dụng thẻ và vé qua tính năng Nhấn thông minh. Bên phát hành mã thưởng được xác định bằng mã nhận dạng bên phát hành. Bên phát hành mã thưởng phải định cấu hình í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à smartTapRedemptionLevel cấp đối tượng để thẻ và vé có thể hỗ trợ tính năng 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)

Hình ảnh biểu ngữ không bắt buộc xuất hiện ở mặt trước 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ị ở 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à smartTapRedemptionLevel ở cấp đối tượng để thẻ/vé hỗ trợ tính năng Chạm thông minh.

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 và 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. Định dạng là #rrggbb, trong đó rrggbb là bộ ba RGB thập lục phân, 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)

Chuỗi đã dịch cho issuerName. Độ 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 phương thức phát hành cho mỗi lần người dùng cuối lưu/xoá đối tượng cho lớp này. Tất cả đối tượng của lớp này đều đủ điều kiện để 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, một ảnh động bảo mật sẽ được hiển thị trên thông tin chi tiết về thẻ và vé.

enum (ViewUnlockRequirement)

Xem các lựa chọn Yêu cầu mở khoá cho ưu đãi.

object (Image)

Hình ảnh tiêu đề dạng ngang của mặt hàng. Khi được cung cấp, hình ảnh này sẽ được dùng thay cho hình ảnh tiêu đề ở góc trên cùng bên trái của chế độ xem thẻ.

enum (NotificationSettingsForUpdates)

Liệu nội dung cập nhật trường cho lớp 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. Chúng tôi sẽ chỉ gửi các thông báo này cho người dùng nếu trường này nằm trong danh sách cho phép. Nếu không được chỉ định, 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.

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 đối tượng tương ứng sẽ được dùng để thay thế.

object (ValueAddedModuleData)

Dữ liệu mô-đun giá trị gia tăng không bắt buộc. Tối đa 10 người trong lớp. Đối với một thẻ và vé, chỉ 10 thẻ và vé sẽ hiển thị, ưu tiên những thẻ và vé từ đối tượng.