REST Resource: offerclass

Tài nguyên: OfferClass

Biểu diễn dưới dạng JSON 
{
  "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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
Trường
kind
(deprecated)

string

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

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 các màn hình nhỏ hơn.
redemptionChannel

enum (RedemptionChannel)

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

string

Bắt buộc. Nhà cung cấp mặt hàng (tên đơn vị tập 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 các màn hình nhỏ hơn.
titleImage

object (Image)

Hình ảnh tiêu đề của ưu đãi. Hình ảnh này xuất hiện ở cả chế độ xem chi tiết và chế độ xem danh sách của ứng dụng.
details

string

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

string

Dòng chữ in nhỏ hoặc các điều khoản của ưu đãi, chẳng hạn như "Giảm giá 20% cho mọi chiếc áo phông tại Adam's Quần áo".
helpUri

object (Uri)

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

object (LocalizedString)

Các chuỗi được 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 các màn hình nhỏ hơn.
localizedProvider

object (LocalizedString)

Các chuỗi được 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.
localizedDetails

object (LocalizedString)

Các chuỗi được dịch để cung cấp thông tin chi tiết.
localizedFinePrint

object (LocalizedString)

Các chuỗi đã được dịch cho Hãy cũng xem các văn bản này.
shortTitle

string

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

object (LocalizedString)

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

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

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 "-".
version
(deprecated)

string (int64 format)

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

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

boolean

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

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).
locations[]

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

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

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.
infoModuleData
(deprecated)

object (InfoModuleData)

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

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.
textModulesData[]

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.
redemptionIssuers[]

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à smartTapRedemptionLevel ở cấp đối tượng để thẻ/vé hỗ trợ tính năng Chạm thông minh.
countryCode

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

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%.
wordMark
(deprecated)

object (Image)

Không dùng nữa.
enableSmartTap

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

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

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

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

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

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

enum (ViewUnlockRequirement)

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

object (Image)

Hình ảnh tiêu đề rộng của ưu đãi. Khi được cung cấp, thông tin này sẽ được sử dụng thay cho hình ảnh tiêu đề ở phía trên cùng bên trái của chế độ xem thẻ.

RedemptionChannel

Enum
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

Bí danh cũ của INSTORE. Không dùng nữa.
ONLINE
online

Bí danh cũ của ONLINE. Không dùng nữa.
BOTH
both

Bí danh cũ của BOTH. Không dùng nữa.
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

Bí danh cũ của TEMPORARY_PRICE_REDUCTION. Không dùng nữa.

Phương thức

addmessage

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

get

 Trả về lớp ưu đãi có mã lớp cho sẵn.

insert

 Chèn một lớp ưu đãi có mã nhận dạng và thuộc tính đã cho.

list

 Trả về danh sách tất cả các lớp ưu đãi của một mã nhà phát hành cụ thể.

patch

 Cập nhật lớp ưu đãi được tham chiếu theo mã lớp đã cho.

update

 Cập nhật lớp ưu đãi được tham chiếu theo mã lớp đã cho.