REST Resource: giftcardclass

Tài nguyên: GiftCardClass

Biểu diễn dưới dạng JSON
{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    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),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
Trường
kind
(deprecated)

string

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

merchantName

string

Tên người bán, chẳng hạn như "Adam's Apparel". Ứng dụng có thể hiển thị dấu ba chấm sau 20 ký tự đầu tiên để đảm bảo chuỗi đầy đủ hiển thị trên màn hình nhỏ hơn.

pinLabel

string

Nhãn hiển thị cho mã PIN, chẳng hạn như "Mã PIN gồm 4 chữ số".

eventNumberLabel

string

Nhãn hiển thị cho số sự kiện, chẳng hạn như "Sự kiện mục tiêu #".

allowBarcodeRedemption

boolean

Xác định xem người bán có hỗ trợ sử dụng thẻ quà tặng bằng mã vạch hay không. Nếu đúng, ứng dụng sẽ hiển thị mã vạch của thẻ quà tặng trên màn hình Thông tin chi tiết về thẻ quà tặng. Nếu giá trị là false, mã vạch sẽ không hiển thị.

localizedMerchantName

object (LocalizedString)

Chuỗi đã dịch cho merchantName. Ứng dụng có thể hiển thị dấu ba chấm sau 20 ký tự đầu tiên để đảm bảo chuỗi đầy đủ hiển thị trên màn hình nhỏ hơn.

localizedPinLabel

object (LocalizedString)

Chuỗi đã dịch cho pinLabel.

localizedEventNumberLabel

object (LocalizedString)

Chuỗi đã dịch cho eventNumberLabel.

cardNumberLabel

string

Nhãn hiển thị cho số thẻ, chẳng hạn như "Số thẻ".

localizedCardNumberLabel

object (LocalizedString)

Chuỗi đã dịch cho cardNumberLabel.

classTemplateInfo

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

id

string

Bắt buộc. Giá trị nhận dạng duy nhất của một lớp. Mã nhận dạng này phải là duy nhất trên tất cả các lớp của một tổ chức 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 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 tổ chức phát hành. Độ dài tối đa đề xuất 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 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.

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

locations[]
(deprecated)

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

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 underReview bằng cách sử dụng lệnh gọi API chèn, bả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 đặt 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à bạn có thể sử dụng trường này ngay lập tức để tạo hoặc di chuyển các đố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)

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.

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, thì cả hai 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 đơn vị phát hành có thể sử dụng thẻ và vé qua tính năng Nhấn thông minh. Công ty phát hành chương trình đổ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 enableSmartTapsmartTapRedemptionLevel cấp đối tượng để thẻ và vé có thể 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)

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ó, thì sẽ không có nội dung nào hiển thị. Hình ảnh sẽ hiển thị ở 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ợ tính năng Nhấn thông minh hay không. Bạn cũng phải thiết lập đúng cách các trường redemptionIssuerssmartTapRedemptionLevel cấp đối tượng để thẻ và vé có thể 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, 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.

localizedIssuerName

object (LocalizedString)

Các chuỗi đã được dịch choNhà phát hànhName. Độ dài tối đa đề xuất 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 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.

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

viewUnlockRequirement

enum (ViewUnlockRequirement)

Xem các tuỳ chọn Yêu cầu mở khoá cho thẻ quà tặng.

notifyPreference

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.

valueAddedModuleData[]

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 việc truyền, chỉ có 10 được hiển thị, ưu tiên những sự kiện từ đối tượng.

Phương thức

addmessage

Thêm thông báo vào lớp thẻ quà tặng được tham chiếu bằng mã lớp đã cho.

get

Trả về lớp thẻ quà tặng có mã lớp đã cho.

insert

Chèn một lớp thẻ quà tặng có mã nhận dạng và thuộc tính đã cho.

list

Trả về danh sách tất cả các loại thẻ quà tặng cho một mã nhận dạng người phát hành nhất định.

patch

Cập nhật lớp thẻ quà tặng được tham chiếu theo mã lớp đã cho.

update

Cập nhật lớp thẻ quà tặng được tham chiếu bằng mã lớp nhất định.