REST Resource: offerclass

資源：OfferClass

JSON 表示法 
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    object (LocalizedString)
  },
  "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),
  "wideTitleImage": {
    object (Image)
  }
}
欄位
kind
(deprecated)

string

識別資源的種類。值：固定字串 "walletobjects#offerClass"。
title

string

必要欄位。優惠的標題，例如「所有 T 恤 8 折」，建議長度上限為 60 個字元，以確保在較小的螢幕上可顯示完整字串。
redemptionChannel

enum (RedemptionChannel)

必要欄位。適用於這項優惠的兌換管道。
provider

string

必要欄位。優惠的供應商 (集結網站名稱或商家名稱)。建議長度上限為 12 個字元，以確保在較小的螢幕上可顯示完整字串。
titleImage

object (Image)

優惠的標題圖片。這張圖片會顯示在應用程式的詳細資料及清單檢視畫面中。
details

string

優惠詳細資料。
finePrint

string

優惠的附屬細則或條款，例如「購買任何小明服飾店的 T 恤可享 8 折優惠」。
helpUri

object (Uri)

優惠的說明連結，例如 http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

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

object (LocalizedString)

提供者的翻譯字串。建議長度上限為 12 個字元，以確保在較小的螢幕上可顯示完整字串。
localizedDetails

object (LocalizedString)

詳細資料的翻譯字串。
localizedFinePrint

object (LocalizedString)

附屬細則的翻譯字串。
shortTitle

string

優惠的短版標題 (例如「8 折優惠」)，方便使用者快速瞭解優惠內容。建議長度上限為 20 個半形字元。
localizedShortTitle

object (LocalizedString)

簡短標題的翻譯字串。建議長度上限為 20 個半形字元。
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[]

object (LatLongPoint)

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

enum (ReviewStatus)

必要欄位。類別的狀態。這個欄位可以設為 draft 或類別的狀態。可以透過 insert、patch 或更新 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 和物件層級的 smartTapRedemptionLevel 欄位，票證才能支援智慧感應功能。
countryCode

string

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

object (Image)

顯示在資訊卡正面的選用橫幅圖片。如果沒有顯示任何項目，系統就不會顯示任何內容。圖片寬度為 100%。
wordMark
(deprecated)

object (Image)

已淘汰。
enableSmartTap

boolean

指出這個類別是否支援智慧感應功能。此外，您也必須正確設定 redemptionIssuers 和物件層級的 smartTapRedemptionLevel 欄位，票證才能支援智慧感應功能。
hexBackgroundColor

string

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

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

關於安全性動畫的選擇性資訊。如果設定了這項政策，票證詳細資料就會顯示安全性動畫。
viewUnlockRequirement

enum (ViewUnlockRequirement)

查看優惠的「解鎖要求」選項。
wideTitleImage

object (Image)

優惠內容寬幅標題圖片。提供此元素會用來取代資訊卡檢視畫面左上方的標題圖片。

RedemptionChannel

列舉
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

INSTORE 的舊版別名，已淘汰。
ONLINE
online

ONLINE 的舊版別名，已淘汰。
BOTH
both

BOTH 的舊版別名，已淘汰。
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

TEMPORARY_PRICE_REDUCTION 的舊版別名，已淘汰。

方法

addmessage

 在指定類別 ID 參照的優惠類別中新增訊息。

get

 傳回具有指定類別 ID 的優惠類別。

insert

 插入具有指定 ID 和屬性的優惠類別。

list

 傳回指定核發者 ID 的所有優惠類別清單。

patch

 更新指定類別 ID 參照的優惠類別。

update

 更新指定類別 ID 參照的優惠類別。