資源:LoyaltyClass
| JSON 表示法 | 
|---|
{ "kind": string, "programName": string, "programLogo": { object (  | 
              
| 欄位 | |
|---|---|
kind | 
                
                   
 表示資源的種類。值:固定字串   | 
              
programName | 
                
                   
 必要欄位。方案名稱,例如「小明服飾店」。應用程式可能會在前 20 個字元之後顯示省略符號,以確保在較小的螢幕上可顯示完整字串。  | 
              
programLogo | 
                
                   
 必要欄位。會員方案或公司的標誌。這個標誌會顯示在應用程式的詳細資料和清單檢視畫面中。  | 
              
accountNameLabel | 
                
                   
 帳戶名稱標籤,例如「會員姓名」。建議長度上限為 15 個字元,以確保在較小的螢幕上可顯示完整字串。  | 
              
accountIdLabel | 
                
                   
 帳戶 ID 標籤,例如「會員 ID」。建議長度上限為 15 個字元,以確保在較小的螢幕上可顯示完整字串。  | 
              
rewardsTierLabel | 
                
                   
 獎勵級別標籤,例如「獎勵級別」。建議長度上限為 9 個字元,以確保在較小的螢幕上可顯示完整字串。  | 
              
rewardsTier | 
                
                   
 獎勵級別,例如「爍金」或「白金」。建議長度上限為 7 個字元,以確保在較小的螢幕上可顯示完整字串。  | 
              
localizedProgramName | 
                
                   
 programName 的翻譯字串。應用程式可能會在前 20 個字元之後顯示省略符號,以確保在較小的螢幕上可顯示完整字串。  | 
              
localizedAccountNameLabel | 
                
                   
 accountNameLabel 的翻譯字串。建議長度上限為 15 個字元,以確保在較小的螢幕上可顯示完整字串。  | 
              
localizedAccountIdLabel | 
                
                   
 accountIdLabel 的翻譯字串。建議長度上限為 15 個字元,以確保在較小的螢幕上可顯示完整字串。  | 
              
localizedRewardsTierLabel | 
                
                   
 rewardsTierLabel 的翻譯字串。建議長度上限為 9 個字元,以確保在較小的螢幕上可顯示完整字串。  | 
              
localizedRewardsTier | 
                
                   
 rewardsTier 的翻譯字串。建議長度上限為 7 個字元,以確保在較小的螢幕上可顯示完整字串。  | 
              
secondaryRewardsTierLabel | 
                
                   
 次要獎勵級別標籤,例如「獎勵級別」。  | 
              
localizedSecondaryRewardsTierLabel | 
                
                   
 secondaryRewardsTierLabel 的翻譯字串。  | 
              
secondaryRewardsTier | 
                
                   
 次要獎勵級別,例如「爍金」或「白金」。  | 
              
localizedSecondaryRewardsTier | 
                
                   
 secondaryRewardsTier 的翻譯字串。  | 
              
discoverableProgram | 
                
                   
 如何在 Google Pay 應用程式中探索類別及建立例項的相關資訊。  | 
              
classTemplateInfo | 
                
                   
 類別顯示方式的範本資訊。如未設定,Google 會恢復為顯示一組預設的欄位。  | 
              
id | 
                
                   
 必要欄位。類別的專屬 ID。這個 ID 不得與同一核發機構的其他類別 ID 相同。這個值應依循 issuer ID 格式。identifier 的格式,其中前者是由 Google 核發,後者則由您指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。  | 
              
version | 
                
                   
 已淘汰  | 
              
issuerName | 
                
                   
 必要欄位。發卡機構名稱。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。  | 
              
messages[] | 
                
                   
 應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限是 10 個。  | 
              
allowMultipleUsersPerObject | 
                
                   
 已淘汰,請改用   | 
              
homepageUri | 
                
                   
 應用程式首頁的 URI。在這個欄位填入 URI 所產生的行為與在 linksModuleData 填入 URI 相同 (顯示物件時,首頁的連結會顯示在通常視為物件 linksModuleData 區段的地方)。  | 
              
locations[] | 
                
                   
 注意:系統目前不支援使用這個欄位觸發地理通知。  | 
              
reviewStatus | 
                
                   
 必要欄位。課程的狀態。可以透過插入、修補或更新 API 呼叫的方式,將這個欄位設為  類別仍在開發階段時,這個欄位應維持  如果您確認類別可供使用,應將這個欄位設為  更新已處於   | 
              
review | 
                
                   
 類別標示為   | 
              
infoModuleData | 
                
                   
 已淘汰,請改用 textModulesData。  | 
              
imageModulesData[] | 
                
                   
 圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個,以及類別物件層級 1 個。  | 
              
textModulesData[] | 
                
                   
 文字模組資料。如果類別中也定義了文字模組資料,則兩項資料都會顯示。這類欄位的顯示數量上限為來自物件的 10 個,以及來自類別的 10 個。  | 
              
linksModuleData | 
                
                   
 連結模組資料。如果物件中也定義了連結模組資料,則兩項資料都會顯示。  | 
              
redemptionIssuers[] | 
                
                   
 指出哪些兌換核發機構可透過智慧感應功能兌換票證。票證兌換機構 ID 可用於辨識票證兌換機構。兌換發放者必須設定至少一個智慧點選按鈕。 
  | 
              
countryCode | 
                
                   
 國家/地區代碼,用於顯示卡片的國家/地區 (當使用者不在該國家/地區時),以及用於顯示本地化內容 (當沒有使用者語言代碼適用的內容時)。  | 
              
heroImage | 
                
                   
 顯示在卡片正面的選用橫幅圖片。如果未提供,就不會顯示任何圖片。圖片會以 100% 寛度顯示。  | 
              
wordMark | 
                
                   
 已淘汰。  | 
              
enableSmartTap | 
                
                   
 識別這個類別是否支援智慧感應功能。  | 
              
hexBackgroundColor | 
                
                   
 卡片的背景顏色。如果未設定,系統會使用主頁橫幅的主要顏色;如果未設定主頁橫幅,系統會使用標誌的主要顏色。格式為 #rrggbb,其中 rrggbb 是採十六進位制的 RGB 三元組,例如   | 
              
localizedIssuerName | 
                
                   
 issuerName 的翻譯字串。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。  | 
              
multipleDevicesAndHoldersAllowedStatus | 
                
                   
 表示是否有多位使用者和多台裝置會儲存參照這個類別的相同物件。  | 
              
callbackOptions | 
                
                   
 使用者每次儲存/刪除這個類別的物件時,都可以使用這些回呼選項來回呼發卡機構。這個類別的所有物件都適用回呼功能。  | 
              
securityAnimation | 
                
                   
 安全防護動畫的相關資訊 (選填)。如果設為此值,系統會在票證詳細資料上顯示安全性動畫。  | 
              
viewUnlockRequirement | 
                
                   
 查看會員卡的「解鎖條件」選項。  | 
              
wideProgramLogo | 
                
                   
 會員方案或公司的寬版標誌。提供此標誌後,系統會在卡片檢視畫面左上角使用此標誌,取代原有的計畫標誌。  | 
              
notifyPreference | 
                
                   
 這個類別的欄位更新是否應觸發通知。如果設為 NOTIFY,我們會嘗試觸發向使用者發出欄位更新通知。只有在欄位屬於許可清單的一部分時,系統才會傳送這些通知給使用者。如未指定,系統就不會觸發任何通知。這項設定是暫時性的,需要在每次 PATCH 或 UPDATE 要求中設定,否則系統不會觸發通知。  | 
              
appLinkData | 
                
                   
 選用應用程式或網站連結,會以按鈕的形式顯示在憑證正面。如果為對應的物件提供 AppLinkData,系統會改用該值。  | 
              
valueAddedModuleData[] | 
                
                   
 選用價值加值模組資料。每堂課最多可容納十位學生。對於通行證,系統只會顯示十個,並優先顯示物件中的通行證。  | 
              
merchantLocations[] | 
                
                   
 商家地點。每門課最多可容納十位學生。超過 10 個的 MerchantLocations 都會遭到拒絕。當使用者進入 Google 設定的圓心半徑範圍內,這些位置就會觸發通知。這個欄位會取代已淘汰的 LatLongPoints。  | 
              
DiscoverableProgram
如何在 Google 錢包應用程式中探索類別及將類別例項化的相關資訊。這是透過搜尋會員方案或禮物卡方案,然後掃描或手動輸入來完成。
| JSON 表示法 | 
|---|
{ "merchantSignupInfo": { object (  | 
                
| 欄位 | |
|---|---|
merchantSignupInfo | 
                  
                     
 透過商家網站註冊方案並為該方案新增有價值項目之功能的相關資訊。使用時機為已啟用 MERCHANT_HOSTED_SIGNUP 時。  | 
                
merchantSigninInfo | 
                  
                     
 透過商家網站登入並為該方案新增有價值項目之功能的相關資訊。使用時機為已啟用 MERCHANT_HOSTED_SIGNIN 時。  | 
                
state | 
                  
                     
 可探索方案的顯示狀態。  | 
                
DiscoverableProgramMerchantSignupInfo
某商家方案的託管註冊流程相關資訊。
| JSON 表示法 | 
|---|
{ "signupWebsite": { object (  | 
                
| 欄位 | |
|---|---|
signupWebsite | 
                  
                     
 將使用者導向商家註冊網站的網址。  | 
                
signupSharedDatas[] | 
                  
                     
 在 POST 要求中傳送至註冊網站網址的使用者資料。這項資訊會先經過編碼再共用,因此商家網站可以預先填入欄位,以便讓使用者註冊可供搜索的方案。  | 
                
DiscoverableProgramMerchantSigninInfo
某商家方案的託管登入流程相關資訊。
| JSON 表示法 | 
|---|
{
  "signinWebsite": {
    object ( | 
                
| 欄位 | |
|---|---|
signinWebsite | 
                  
                     
 將使用者導向商家登入網站的網址。  | 
                
州
| 列舉 | |
|---|---|
STATE_UNSPECIFIED | 
                  |
TRUSTED_TESTERS | 
                  只有可存取核發機構帳戶的測試人員才能看到。 | 
trustedTesters | 
                  
  | 
                
LIVE | 
                  所有使用者都能看到。 | 
live | 
                  
  | 
                
DISABLED | 
                  無法看到。 | 
disabled | 
                  
  | 
                
方法 | 
            |
|---|---|
                
 | 
              新增訊息至指定類別 ID 參照的會員類別。 | 
                
 | 
              傳回具有指定類別 ID 的會員類別。 | 
                
 | 
              插入具有指定 ID 和屬性的會員類別。 | 
                
 | 
              傳回指定發卡機構 ID 的所有會員類別清單。 | 
                
 | 
              更新指定類別 ID 參照的會員類別。 | 
                
 | 
              更新指定類別 ID 參照的會員類別。 |