REST Resource: loyaltyclass

資源：LoyaltyClass

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)
    }
  ]
}
欄位
kind
(deprecated)

string

表示資源的種類。值：固定字串 "walletobjects#loyaltyClass"。
programName

string

必要欄位。方案名稱，例如「小明服飾店」。應用程式可能會在前 20 個字元之後顯示省略符號，以確保在較小的螢幕上可顯示完整字串。
accountNameLabel

string

帳戶名稱標籤，例如「會員名稱」。建議長度上限為 15 個字元，以確保在較小的螢幕上可顯示完整字串。
accountIdLabel

string

帳戶 ID 標籤，例如「會員 ID」。建議長度上限為 15 個字元，以確保在較小的螢幕上可顯示完整字串。
rewardsTierLabel

string

獎勵級別標籤，例如「獎勵級別」。建議長度上限為 9 個字元，以確保在較小的螢幕上可顯示完整字串。
rewardsTier

string

獎勵級別，例如「爍金」或「白金」。建議長度上限為 7 個字元，以確保在較小的螢幕上可顯示完整字串。
localizedProgramName

object (LocalizedString)

programName 的翻譯字串。應用程式可能會在前 20 個字元之後顯示刪節號，以確保在較小的螢幕上可顯示完整字串。
localizedAccountNameLabel

object (LocalizedString)

accountNameLabel 的翻譯字串。建議長度上限為 15 個字元，以確保在較小的螢幕上可顯示完整字串。
localizedAccountIdLabel

object (LocalizedString)

accountIdLabel 的翻譯字串。建議長度上限為 15 個字元，以確保在較小的螢幕上可顯示完整字串。
localizedRewardsTierLabel

object (LocalizedString)

RewardsTierLabel 的翻譯字串。建議長度上限為 9 個字元，以確保在較小的螢幕上可顯示完整字串。
localizedRewardsTier

object (LocalizedString)

rewardsTier 的翻譯字串。建議長度上限為 7 個字元，以確保在較小的螢幕上可顯示完整字串。
secondaryRewardsTierLabel

string

次要獎勵級別標籤，例如「獎勵級別」。
localizedSecondaryRewardsTierLabel

object (LocalizedString)

secondaryRewardsTierLabel 的翻譯字串。
secondaryRewardsTier

string

次要獎勵級別，例如「爍金」或「白金」。
localizedSecondaryRewardsTier

object (LocalizedString)

secondaryRewardsTier 的翻譯字串。
discoverableProgram

object (DiscoverableProgram)

如何在 Google Pay 應用程式中探索類別及建立例項的相關資訊。
classTemplateInfo

object (ClassTemplateInfo)

類別顯示方式的範本資訊。如未設定，Google 會恢復為顯示一組預設的欄位。
id

string

必要欄位。類別的專屬 ID。特定核發者的所有類別 ID 都不得重複。這個值應依循 issuer ID 格式。identifier 的格式，其中前者是由 Google 核發，後者則由您指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。
version
(deprecated)

string (int64 format)

已淘汰
issuerName

string

必要欄位。發卡機構名稱。建議長度上限為 20 個字元，以確保在較小的螢幕上可顯示完整字串。
messages[]

object (Message)

應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限是 10 個。
allowMultipleUsersPerObject
(deprecated)

boolean

已淘汰，請改用 multipleDevicesAndHoldersAllowedStatus。
homepageUri

object (Uri)

應用程式首頁的 URI。在這個欄位填入 URI 所產生的行為與在 linksModuleData 填入 URI 相同 (轉譯物件時，首頁的連結會顯示在通常視為物件 linksModuleData 區段的地方)。
locations[]
(deprecated)

object (LatLongPoint)

注意：系統目前不支援使用這個欄位觸發地理通知。
reviewStatus

enum (ReviewStatus)

必要欄位。課程的狀態。可以透過插入、修補或更新 API 呼叫的方式，將這個欄位設為 draft 或 underReview。一旦審查狀態從 draft 變更為其他狀態，就無法再變回 draft。

當類別處於開發階段時，這個欄位應保留為 draft。draft 類別無法用於建立任何物件。

如果您確認類別可供使用，應將這個欄位設為 underReview。平台會自動將這個欄位設為 approved，這樣就能立即用於建立或遷移物件。

更新已處於 approved 的類別時，請繼續將這個欄位設為 underReview。
review

object (Review)

當類別標示為 approved 或 rejected 時，平台所設定的審查留言。
infoModuleData
(deprecated)

object (InfoModuleData)

已淘汰，請改用 textModulesData。
imageModulesData[]

object (ImageModuleData)

圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個，以及類別物件層級 1 個。
textModulesData[]

object (TextModuleData)

文字模組資料。如果類別中也定義了文字模組資料，則兩項資料都會顯示。這類欄位的顯示數量上限為物件的 10 個，以及來自類別的 10 個欄位。
redemptionIssuers[]

string (int64 format)

指出哪些兌換核發機構可透過智慧感應功能兌換票證。系統會透過核發機構 ID 來辨識兌換核發機構。兌換核發機構至少須設定一組智慧感應功能金鑰。

您必須正確設定 enableSmartTap 和物件層級的 smartTapRedemptionValue、barcode.value, oraccountId` 欄位，票證才能支援智慧感應功能。
countryCode

string

國家/地區代碼，用於顯示卡片的國家/地區 (當使用者不在該國家/地區時)，以及用於顯示本地化內容 (當沒有使用者語言代碼適用的內容時)。
heroImage

object (Image)

顯示在卡片正面的選用橫幅圖片。如果未提供，就不會顯示任何內容。圖片會以 100% 寬度顯示。
wordMark
(deprecated)

object (Image)

已淘汰。
enableSmartTap

boolean

識別這個類別是否支援智慧感應功能。redemptionIssuers 和物件層級的 smartTapRedemptionLevel、barcode.value, or accountId` 欄位也必須正確設定，才能讓票證支援智慧觸碰功能。
hexBackgroundColor

string

卡片的背景顏色。如未設定，則會使用主頁橫幅的主要顏色。如未設定主頁橫幅，則會使用標誌的主要顏色。格式為 #rrggbb，其中 rrggbb 是採十六進位制的 RGB 三位元組，例如 #ffcc00。您也可以使用 RGB 三元組的簡寫版本 #rgb，例如 #fc0。
localizedIssuerName

object (LocalizedString)

issuerName 的翻譯字串。建議長度上限為 20 個字元，以確保在較小的螢幕上可顯示完整字串。
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

表示是否有多位使用者和多台裝置會儲存參照這個類別的相同物件。
callbackOptions

object (CallbackOptions)

使用者每次儲存/刪除這個類別的物件時，都可以使用這些回呼選項來回呼發卡機構。這個類別的所有物件都適用回呼功能。
securityAnimation

object (SecurityAnimation)

安全動畫的選用資訊。如果設定此屬性，票證詳細資料上會顯示安全性動畫。
viewUnlockRequirement

enum (ViewUnlockRequirement)

查看會員卡的「解鎖條件」選項。
notifyPreference

enum (NotificationSettingsForUpdates)

這個類別的欄位更新是否應觸發通知。如果設為 NOTIFY，我們會嘗試觸發向使用者發出欄位更新通知。只有在欄位屬於許可清單的一部分時，系統才會傳送這些通知給使用者。如未指定，系統就不會觸發任何通知。這是暫時性的設定，且必須為每個 PATCH 或 UPDATE 要求進行設置，否則不會觸發通知。
valueAddedModuleData[]

object (ValueAddedModuleData)

選用值新增模組資料。每堂課最多可容納十位學生。對於通行證，系統只會顯示十個，並優先顯示物件中的通行證。

DiscoverableProgram

如何在 Android Pay 應用程式中探索類別及建立例項的相關資訊。這是透過搜尋會員方案或儲值卡方案，然後掃描或手動輸入來完成。

JSON 表示法 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
欄位
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

透過商家網站註冊方案並為該方案新增有價值項目之功能的相關資訊。使用時機為已啟用 MERCHANT_HOSTED_SIGNUP 時。
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

透過商家網站登入並為該方案新增有價值項目之功能的相關資訊。在啟用 MERCHANT_HOSTED_SIGNIN 時使用。
state

enum (State)

可探索方案的顯示狀態。

DiscoverableProgramMerchantSignupInfo

某商家方案的託管註冊流程相關資訊。

JSON 表示法 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
欄位
signupWebsite

object (Uri)

將使用者導向商家註冊網站的網址。
signupSharedDatas[]

enum (SharedDataType)

在 POST 要求中傳送至註冊網站網址的使用者資料。這項資訊會先經過編碼再共用，因此商家網站可以預先填入欄位，以便讓使用者註冊可供搜索的方案。

SharedDataType

列舉
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS 單行地址欄位
ADDRESS_LINE_1 多行地址欄位
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

某商家方案的託管登入流程相關資訊。

JSON 表示法 
{
  "signinWebsite": {
    object (Uri)
  }
}
欄位
signinWebsite

object (Uri)

將使用者導向商家登入網站的網址。

州

列舉
STATE_UNSPECIFIED
TRUSTED_TESTERS 只有可存取核發者帳戶的測試人員才能看到。
trustedTesters

TRUSTED_TESTERS 的舊版別名，已淘汰。
LIVE 所有使用者都能看到。
live

LIVE 的舊版別名，已淘汰。
DISABLED 無法查看。
disabled

DISABLED 的舊版別名，已淘汰。

方法

addmessage

 新增訊息至指定類別 ID 參照的會員類別。

get

 傳回具有指定類別 ID 的會員類別。

insert

 插入具有指定 ID 和屬性的會員類別。

list

 傳回指定發卡機構 ID 的所有會員類別清單。

patch

 更新指定類別 ID 參照的會員類別。

update

 更新指定類別 ID 參照的會員類別。