REST 資源: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)
  }
}
欄位
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)

可以使用物件的位置清單。平台會使用這項資訊以觸發向使用者顯示的地理位置通知。請注意,物件中的位置會覆寫類別中的位置,類別中的位置會覆寫 Google 地方資訊 ID 中的位置。

reviewStatus

enum (ReviewStatus)

必要。類別的狀態。此欄位可以設定為 draft 或類別的狀態。可以透過 insert、patch 或 update 的 API 呼叫,將這個欄位設定為 draftunderReview。一但審查狀態從 draft 變更為其他狀態,就無法再變回 draft

當類別處於發展階段時,這個欄位應保持為 draftdraft 類別無法用於建立任何物件。

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

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

review

object (Review)

當類別被標示為 approvedrejected 時,平台所設定的審查留言。

infoModuleData
(deprecated)

object (InfoModuleData)

已淘汰,請改用 textModulesData。

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

redemptionIssuers[]

string (int64 format)

僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。

countryCode

string

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

heroImage

object (Image)

顯示在卡片正面的選用橫幅圖片。如果未提供,就不會顯示任何圖片。圖片會以 100% 寛度顯示。

wordMark
(deprecated)

object (Image)

已淘汰。

enableSmartTap

boolean

僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

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 參照的優惠類別。