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)
    }
  ],
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
欄位
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 個。
valueAddedModuleData[]

object (ValueAddedModuleData)

選用值新增模組資料。每堂課最多可容納十位學生。對於通行證，系統只會顯示十個，並優先顯示物件中的通行證。

方法

addmessage

 在指定類別 ID 參照的通用類別中新增訊息。

get

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

insert

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

list

 傳回指定發卡機構 ID 的所有通用類別清單。

patch

 更新指定類別 ID 參照的一般類別。

update

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