REST Resource: loyaltyclass

Tài nguyên: LoyaltyClass

Biểu diễn dưới dạng JSON 
{
  "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)
  },
  "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#loyaltyClass".
programName

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ể 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.
accountNameLabel

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

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

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 được đề xuất là 9 ký tự để đảm bảo chuỗi đầy đủ hiển thị trên màn hình nhỏ hơn.
rewardsTier

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

object (LocalizedString)

Chuỗi đã dịch cho programName. Ứ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.
localizedAccountNameLabel

object (LocalizedString)

Chuỗi đã 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.
localizedAccountIdLabel

object (LocalizedString)

Chuỗi đã 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 màn hình nhỏ hơn.
localizedRewardsTierLabel

object (LocalizedString)

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

object (LocalizedString)

Chuỗi đã 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 màn hình nhỏ hơn.
secondaryRewardsTierLabel

string

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

object (LocalizedString)

Chuỗi đã dịch cho secondaryRewardsTierLabel.
secondaryRewardsTier

string

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

object (LocalizedString)

Chuỗi đã dịch cho secondaryRewardsTier.
discoverableProgram

object (DiscoverableProgram)

Thông tin về cách phát hiện và tạo bản sao lớp trong ứng dụng Google Pay.
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 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 ("-").
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 đượ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 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, 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 đã là approved, bạn nên tiếp tục đặt 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 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.
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 tổ chức phát hành thẻ đổi thưởng có thể sử dụng thẻ/vé qua tính năng Chạm 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à 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.
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ợ công nghệ Chạm thông minh hay không. Bạn cũng phải thiết lập đúng redemptionIssuers và một trong các trường cấp đối tượng smartTapRedemptionLevel, barcode.value, or accountId` để 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 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 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)

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.
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, ả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 tuỳ chọn Yêu cầu mở khoá cho thẻ khách hàng thân thiết.
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. Những thông báo này sẽ chỉ được gửi đến người dùng nếu trường đó 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 này. Đố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.

DiscoverableProgram

Thông tin về cách phát hiện và tạo bản sao của một lớp trong ứng dụng Android Pay. Bạn có thể thực hiện việc này bằng cách tìm kiếm chương trình khách hàng thân thiết hoặc thẻ quà tặng, sau đó quét hoặc nhập theo cách thủ công.

Biểu diễn dưới dạng JSON 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
Trường
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

Thông tin về khả năng đăng ký và thêm phần thưởng cho chương trình này thông qua trang web của người bán. Được sử dụng khi MERCHANT_ bổ_ tội được bật.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Thông tin về khả năng đăng nhập và thêm phần thưởng cho chương trình này thông qua trang web của người bán. Được dùng khi bạn bật MERCHANT_HOSTED_SIGNIN.
state

enum (State)

Trạng thái hiển thị của chương trình có thể phát hiện.

DiscoverableProgramMerchantSignupInfo

Thông tin về quy trình đăng ký do người bán lưu trữ cho một chương trình.

Biểu diễn dưới dạng JSON 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
Trường
signupWebsite

object (Uri)

URL để chuyển người dùng đến trang web đăng ký của người bán.
signupSharedDatas[]

enum (SharedDataType)

Dữ liệu người dùng được gửi trong yêu cầu POST đến URL của trang web đăng ký. Thông tin này được mã hoá rồi chia sẻ để trang web của người bán có thể điền sẵn các trường dùng để đăng ký người dùng tham gia chương trình có thể khám phá.

SharedDataType

Enum
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS trường địa chỉ một dòng
ADDRESS_LINE_1 trường địa chỉ nhiều dòng
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

Thông tin về quy trình đăng nhập do người bán lưu trữ cho một chương trình.

Biểu diễn dưới dạng JSON 
{
  "signinWebsite": {
    object (Uri)
  }
}
Trường
signinWebsite

object (Uri)

URL để chuyển hướng người dùng đến trang web đăng nhập của người bán.

Tiểu bang

Enum
STATE_UNSPECIFIED
TRUSTED_TESTERS Chỉ những người kiểm thử có quyền truy cập vào tài khoản của tổ chức phát hành mới nhìn thấy.
trustedTesters

Bí danh cũ của TRUSTED_TESTERS. Không dùng nữa.
LIVE Mọi người đều nhìn thấy.
live

Bí danh cũ của LIVE. Không dùng nữa.
DISABLED Không hiển thị.
disabled

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

Phương thức

addmessage

 Thêm thông báo vào lớp khách hàng thân thiết được tham chiếu bằng mã lớp đã cho.

get

 Trả về lớp khách hàng thân thiết có mã lớp đã cho.

insert

 Chèn một lớp khách hàng thân thiết có mã nhận dạng và thuộc tính đã cho.

list

 Trả về danh sách tất cả các hạng khách hàng thân thiết của một mã công ty phát hành cụ thể.

patch

 Cập nhật lớp khách hàng thân thiết được tham chiếu theo mã lớp đã cho.

update

 Cập nhật lớp khách hàng thân thiết được tham chiếu theo mã lớp đã cho.