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)
  }
}
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ể cho thấy dấu ba chấm sau 20 ký tự đầu tiên để đảm bảo toàn bộ chuỗi 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". Bạn nên sử dụng độ dài tối đa 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". Bạn nên sử dụng độ dài tối đa 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 theo bậc phần thưởng, chẳng hạn như "Cấp phần thưởng". Bạn nên sử dụng độ dài tối đa 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". Bạn nên sử dụng độ dài tối đa 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)

Các chuỗi được dịch cho programName. Ứng dụng có thể cho thấy dấu ba chấm sau 20 ký tự đầu tiên để đảm bảo toàn bộ chuỗi hiển thị trên màn hình nhỏ hơn.
localizedAccountNameLabel

object (LocalizedString)

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

object (LocalizedString)

Các chuỗi được dịch cho accountIdLabel. Bạn nên sử dụng độ dài tối đa 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 bản dịch cho rewardTierLabel. Bạn nên sử dụng độ dài tối đa 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)

Các chuỗi văn bản được dịch cho phần thưởngTier. Bạn nên sử dụng độ dài tối đa 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)

Các chuỗi đã được dịch cho danh mục phụRewardsTierLabel.
secondaryRewardsTier

string

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

object (LocalizedString)

Các chuỗi được dịch cho bậc phụ RewardsTier.
discoverableProgram

object (DiscoverableProgram)

Thông tin về cách hệ thống có thể tìm thấy và tạo bản sao của 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 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 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 enableSmartTap và một trong các trường smartTapRedemptionValue, encrypted.value, oraccountId` cấp đối tượng để một 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 đã 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 redemptionIssuers và một trong các trường smartTapRedemptionLevel, encrypted.value, or accountId` cấp đối tượng để một 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 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 tuỳ chọn Yêu cầu mở khoá cho thẻ khách hàng thân thiết.

DiscoverableProgram

Thông tin về cách hệ thống có thể tìm thấy và tạo bản sao lớp học từ trong ứng dụng Android Pay. Việc này được thực hiện 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 và 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 giá trị cho chương trình này thông qua trang web của người bán. Được sử dụng khi MERCHANT_Directory_unsubscribe được bật.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

Thông tin về khả năng đăng nhập và thêm lợi ích có giá trị cho chương trình này thông qua trang web của người bán. Được sử dụng khi MERCHANT_Directory_miền được bật.
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 qua yêu cầu POST đến URL của trang web đăng ký. Thông tin này được mã hoá và sau đó 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ể tìm thấy.

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ề luồng đă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 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 nhà phát hành mới nhìn thấy được.
trustedTesters

Bí danh cũ của TRUSTED_TESTERS. Không dùng nữa.
LIVE Hiển thị với tất cả mọi người.
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 một thông báo vào lớp khách hàng thân thiết được tham chiếu theo mã lớp nhất định.

get

 Trả về hạng của chương trình khách hàng thân thiết có mã lớp cho trước.

insert

 Chèn một hạng khách hàng thân thiết có mã nhận dạng và các 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ã nhà phát hành nhất định.

patch

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

update

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