資源:OfferClass
JSON 表示法 |
---|
{ "kind": string, "title": string, "redemptionChannel": enum ( |
欄位 | |
---|---|
kind |
標示資源的種類。值:固定字串 |
title |
必要欄位。優惠的標題,例如「所有 T 恤皆可享 8 折優惠」。建議長度上限為 60 個字元,以確保在較小的螢幕上可顯示完整字串。 |
redemptionChannel |
必要欄位。適用於這項優惠的兌換管道。 |
provider |
必要欄位。優惠的供應商 (集結網站或商家名稱)。建議長度上限為 12 個字元,以確保在較小的螢幕上可顯示完整字串。 |
titleImage |
優惠的標題圖片。這張圖片會顯示在應用程式的詳細資料及清單檢視畫面中。 |
details |
優惠詳細資料。 |
finePrint |
優惠的附屬細則或條款,例如「購買任何小明服飾店的 T 恤可享 8 折優惠」。 |
helpUri |
優惠的說明連結,例如 |
localizedTitle |
標題的翻譯字串。建議長度上限為 60 個字元,以確保在較小的螢幕上可顯示完整字串。 |
localizedProvider |
提供者的翻譯字串。建議長度上限為 12 個字元,以確保在較小的螢幕上可顯示完整字串。 |
localizedDetails |
詳細資料的翻譯字串。 |
localizedFinePrint |
附屬細則的翻譯字串。 |
shortTitle |
優惠的短版標題,例如「8 折優惠」方便使用者快速瞭解優惠內容。建議長度上限為 20 個字元。 |
localizedShortTitle |
短標題的翻譯字串。建議長度上限為 20 個字元。 |
classTemplateInfo |
類別顯示方式的範本資訊。如未設定,Google 會改回顯示一組預設欄位。 |
id |
必要欄位。類別的專屬 ID。特定核發者的所有類別 ID 都不得重複。這個值應依循 issuer ID 格式。identifier 的格式,其中前者是由 Google 核發,後者則由您指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
version |
已淘汰 |
issuerName |
必要欄位。核發者名稱。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。 |
messages[] |
應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到相關訊息。這類欄位的數量上限是 10 個。 |
allowMultipleUsersPerObject |
已淘汰,請改用 |
homepageUri |
應用程式首頁的 URI。在這個欄位填入 URI 所產生的行為與在 linksModuleData 填入 URI 相同 (轉譯物件時,首頁的連結會顯示在通常視為物件 linksModuleData 區段的地方)。 |
locations[] |
注意:這個欄位目前不支援觸發地理通知。 |
reviewStatus |
必要欄位。類別的狀態。這個欄位可以設為 當類別處於開發階段時,這個欄位應保留為 如果您確認類別可供使用,應將這個欄位設為 更新已處於 |
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 |
查看該優惠的「解鎖需求條件」。 |
wideTitleImage |
優惠的寬版標題圖片。這項資訊會用來取代資訊卡檢視畫面左上方的標題圖片。 |
appLinkData |
應用程式或網站連結 (選用) 會顯示為票證正面按鈕。如果為相對應的物件提供 AppLinkData,系統會改用該物件。 |
RedemptionChannel
列舉 | |
---|---|
REDEMPTION_CHANNEL_UNSPECIFIED |
|
INSTORE |
|
instore |
|
ONLINE |
|
online |
|
BOTH |
|
both |
|
TEMPORARY_PRICE_REDUCTION |
|
temporaryPriceReduction |
|
方法 |
|
---|---|
|
新增訊息至指定類別 ID 參照的優惠類別。 |
|
傳回具有指定類別 ID 的優惠類別。 |
|
插入具有指定 ID 和屬性的優惠類別。 |
|
傳回指定核發者 ID 的所有優惠類別清單。 |
|
更新指定類別 ID 參照的優惠類別。 |
|
更新指定類別 ID 參照的優惠類別。 |