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)
  }
}
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 bất kỳ áo thun nào". Bạn nên sử dụng độ dài tối đa là 60 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên màn hình nhỏ hơn.
redemptionChannel

enum (RedemptionChannel)

Bắt buộc. Các kênh đổi thưởng á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). Bạn nên sử dụng độ dài tối đa là 12 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên màn hình nhỏ hơn.
titleImage

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

string

Chi tiết về ưu đãi.
finePrint

string

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

object (Uri)

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

object (LocalizedString)

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

object (LocalizedString)

Các chuỗi được dịch cho trình cung cấp. Bạn nên sử dụng độ dài tối đa là 12 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên màn hình nhỏ hơn.
localizedDetails

object (LocalizedString)

Các chuỗi được dịch để biết chi tiết.
localizedFinePrint

object (LocalizedString)

Các chuỗi văn bản được dịch cho giao diện văn bản nhỏ.
shortTitle

string

Phiên bản rút gọn của tiêu đề của ưu đãi, chẳng hạn như "Giảm giá 20%", hiển thị cho người dùng để giới thiệu nhanh nội dung của ưu đãi. Độ dài tối đa đề 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 đề xuất là 20 ký tự.
classTemplateInfo

object (ClassTemplateInfo)

Thông tin mẫu về cách hiển thị lớp. Nếu bạn không đặt trường này, Google sẽ dự phòng đến một 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 của một nhà phát hành phải là duy nhất trên tất cả các lớp. Giá trị này phải tuân theo định dạng issuer ID.identifier, trong đó mã do Google phát hành và 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. Bạn nên sử dụng độ dài tối đa là 20 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên màn hình nhỏ hơn.
messages[]

object (Message)

Một dãy thông báo hiển thị trong ứng dụng. Tất cả người dùng đối tượng này sẽ nhận được các tin nhắn liên quan. Số lượng tối đa củ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 của trang chủ ứng dụng. Việc điền URI trong trường này sẽ dẫn đến hành vi giống hệt như việc đ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 trong 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 địa lý.
reviewStatus

enum (ReviewStatus)

Bắt buộc. Trạng thái của lớp. 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 chèn, vá hoặc cập nhật các lệnh gọi API. Sau khi thay đổi trạng thái xem xét từ draft, bạn không thể chuyển lại về draft.

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

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

object (Review)

Các nhận xét về bài đá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 tối đa các trường này được hiển thị là 1 ở cấp đối tượng và 1 cho 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, thì cả hai sẽ hiển thị. Số lượng tối đa các trường này 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 thẻ và vé có thể sử dụng tính năng Chạm thông minh. Nhà phát hành đổi thưởng được xác định theo mã nhà phát hành của họ. Nhà phát hành chương trình đổi thưởng 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 chính xác các trường smartTapRedemptionLevel ở cấp đối tượng và enableSmartTap để hệ thống có thể truyền 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 đã bản địa hoá khi nội dung không có sẵn 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ó giá trị nào hiển thị thì sẽ không có gì 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 chính xác các trường smartTapRedemptionLevel ở cấp đối tượng và redemptionIssuers để hệ thống có thể truyền 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 thiết lập màu chủ đạo của hình ảnh chính sẽ được sử dụng, còn nếu bạn không thiết lập 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 hệ thập lục phân 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 #rgb, chẳng hạn như #fc0.
localizedIssuerName

object (LocalizedString)

Chuỗi văn bản được dịch cho tên nhà phát hành. Bạn nên sử dụng độ dài tối đa là 20 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên 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 trình phát hành mỗi khi người dùng cuối lưu/xoá một đối tượng cho lớp này. Mọi đối tượng của lớp này đều đủ điều kiện để sử dụng 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 chế độ này, một ảnh động bảo mật sẽ hiển thị khi bạn truyền thông tin chi tiết.
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, hình ảnh 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 một 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 trước.

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 đối với một mã nhà phát hành nhất định.

patch

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

update

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