REST Resource: genericclass

資源:GenericClass

一般類別

JSON 表示法
{
  "id": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "enableSmartTap": boolean,
  "redemptionIssuers": [
    string
  ],
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "messages": [
    {
      object (Message)
    }
  ]
}
欄位
id

string

必要欄位。類別的專屬 ID。特定核發機構的所有 ID 均不得重複。這個值必須符合 issuerID.identifier 格式,其中 issuerID 是由 Google 核發,並由您選擇 identifier。專屬 ID 只能包含英數字元、._-

classTemplateInfo

object (ClassTemplateInfo)

類別顯示方式的範本資訊。如未設定,Google 會改回顯示一組預設欄位。

imageModulesData[]

object (ImageModuleData)

圖片模組資料。如果物件中也定義了 imageModulesData,則系統會顯示兩者。當兩者都設定時,系統只會算繪類別中的一張圖片,另一張來自物件層級的圖片。

textModulesData[]

object (TextModuleData)

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

enableSmartTap

boolean

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

redemptionIssuers[]

string (int64 format)

找出哪些兌換核發機構可以透過智慧感應功能兌換票證。兌換核發機構由其核發機構 ID 識別。兌換核發機構必須設定至少一個智慧感應功能。

此外,您也必須正確設定 enableSmartTap 和物件層級的 smartTapRedemptionLevel 欄位,票證才能支援智慧感應功能。

securityAnimation

object (SecurityAnimation)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

viewUnlockRequirement

enum (ViewUnlockRequirement)

查看一般票證的解鎖要求選項。

messages[]

object (Message)

應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限為 10 個。

方法

addmessage

新增訊息至指定類別 ID 參照的泛型類別。

get

傳回具有指定類別 ID 的泛型類別。

insert

插入具有指定 ID 和屬性的泛型類別。

list

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

patch

更新指定類別 ID 參照的泛型類別。

update

更新指定類別 ID 參照的「Generic」類別。