資源:GiftCardClass
JSON 表示法 |
---|
{ "kind": string, "merchantName": string, "programLogo": { object ( |
欄位 | |
---|---|
kind |
指出資源的類型。值:固定字串 |
merchantName |
商家名稱,例如「小明服飾」。應用程式可能會在前 20 個字元之後顯示刪節號,以確保在較小的螢幕上可顯示完整字串。 |
programLogo |
禮物卡計畫或公司的標誌。這個標誌會顯示在應用程式的詳細資料及清單檢視畫面中。 |
pinLabel |
用來表示 PIN 碼的標籤,例如「4 位數 PIN 碼」。 |
eventNumberLabel |
用來顯示活動編號的標籤,例如「目標活動編號」。 |
allowBarcodeRedemption |
決定商家是否支援使用條碼兌換禮物卡。如果為 true,應用程式會在禮物卡詳細資料畫面上顯示禮物卡條碼。如果值為 false,則不會顯示條碼。 |
localizedMerchantName |
businessName 的翻譯字串。應用程式可能會在前 20 個字元之後顯示刪節號,以確保在較小的螢幕上可顯示完整字串。 |
localizedPinLabel |
pinLabel 的翻譯字串。 |
localizedEventNumberLabel |
eventNumberLabel 的翻譯字串。 |
cardNumberLabel |
用來表示卡號的標籤,例如「卡號」。 |
localizedCardNumberLabel |
cardNumberLabel 的翻譯字串。 |
classTemplateInfo |
類別顯示方式的範本資訊。如未設定,Google 會改回顯示一組預設欄位。 |
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 |
providerName 的翻譯字串。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。 |
multipleDevicesAndHoldersAllowedStatus |
表示多位使用者和裝置是否會儲存參照這個類別的相同物件。 |
callbackOptions |
每當使用者儲存/刪除這個類別的物件時,可以使用這些回呼選項來呼叫發卡機構。這個類別的所有物件都有資格使用回呼。 |
securityAnimation |
安全性動畫的選用資訊。如果設定這個屬性,系統會在票證詳細資料中顯示安全性動畫。 |
viewUnlockRequirement |
查看禮物卡的解鎖規定選項。 |
wideProgramLogo |
禮物卡方案或公司的寬標誌。如有提供,此標記會取代卡片檢視畫面左上方的計畫標誌。 |
方法 |
|
---|---|
|
新增訊息至指定類別 ID 參照的禮物卡類別。 |
|
傳回具有指定類別 ID 的禮物卡類別。 |
|
插入具有指定 ID 和屬性的禮物卡類別。 |
|
傳回指定核發機構 ID 的所有禮物卡類別清單。 |
|
更新指定類別 ID 參照的禮物卡類別。 |
|
更新指定類別 ID 參照的禮物卡類別。 |