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)
  }
}
欄位
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 參照的泛型類別。