REST Resource: genericobject

資源:GenericObject

通用物件下一個 ID:121

JSON 表示法
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  }
}
欄位
genericType

enum (GenericType)

指定卡片所屬的GenericType

cardTitle

object (LocalizedString)

必要欄位。票證的標頭。通常是商家名稱,例如「XXX Gym」、「AAA 保險」。這是必填欄位,顯示在票證頂端的標題列中。

subheader

object (LocalizedString)

票證的標題標籤,例如這張票證適用的位置。顯示在票證詳細資料檢視畫面中的標題列上方。

header

object (LocalizedString)

必要欄位。票證的標題,例如「優待券可享 5 折優惠」、「媒體庫卡」或「優待券」。此為必填欄位,會顯示在票證詳細資料檢視畫面的標題列中。

hexBackgroundColor

string

資訊卡的背景顏色。如果未設定,則會使用主頁橫幅的主色。如果未設定主頁橫幅,則會使用標誌的主要顏色。如未設定標誌,Google 就會選擇顏色。

notifications

object (Notifications)

這個物件已啟用的通知設定。

id

string

必要欄位。物件的專屬 ID。特定核發者的所有物件 ID 都不得重複。這個值必須採用 issuerID.identifier 格式,其中 issuerID 是由 Google 核發,而 identifier 是由您選擇。專屬 ID 只能包含英數字元、._-

classId

string

必要欄位。與這個物件相關聯的類別,類別必須與這個物件的類型相同、已存在,且已經過核准。

類別 ID 應遵循 issuerID.identifier 格式,其中 issuerID 是由 Google 核發,且 identifier 是由您選擇。

barcode

object (Barcode)

條碼類型和值。如果票證沒有條碼,我們可允許核發機構設定 Barcode.alternate_text 並只顯示該票證。

heroImage

object (Image)

顯示在卡片正面的橫幅圖片 (如有)。圖片將以 100% 寬度顯示。

validTimeInterval

object (TimeInterval)

系統會將這個物件視為有效或可使用的時間範圍。超過時間範圍後,物件就會視為已過期,進而影響使用者裝置中的顯示情形。

imageModulesData[]

object (ImageModuleData)

圖片模組資料。設定兩者時,系統只會算繪類別中的一張圖片和物件層級的圖片。

textModulesData[]

object (TextModuleData)

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

groupingInfo

object (GroupingInfo)

用於控管票證分組方式的資訊。

smartTapRedemptionValue

string

系統會針對這個物件透過 NFC 傳輸至通過智慧感應功能認證的感應式刷卡機的值。類別層級欄位 enableSmartTapredemptionIssuers 都必須正確設定,票證才能支援智慧感應功能。系統僅支援 ASCII 字元。

rotatingBarcode

object (RotatingBarcode)

輪替的條碼設定/詳細資料。

state

enum (State)

物件的狀態。這個欄位可用來判斷物件在應用程式中的顯示方式。舉例來說,inactive 物件會移至「過期的票證」區段。如果未提供這個項目,系統會將物件視為 ACTIVE

hasUsers

boolean

表示這個物件是否有使用者。這個欄位是由平台設定。

passConstraints

object (PassConstraints)

傳遞物件的限制。包括限制 NFC 和螢幕截圖行為。

GenericType

一般資訊卡的類型。

列舉
GENERIC_TYPE_UNSPECIFIED 未指定的泛型類型。
GENERIC_SEASON_PASS 整季節目憑證
GENERIC_UTILITY_BILLS 公用事業帳單
GENERIC_PARKING_PASS 停車證
GENERIC_VOUCHER 優待券
GENERIC_GYM_MEMBERSHIP 健身房會員卡
GENERIC_LIBRARY_MEMBERSHIP 圖書館會員卡
GENERIC_RESERVATIONS 預留項目
GENERIC_AUTO_INSURANCE 汽車保險卡
GENERIC_HOME_INSURANCE 住宅保險卡
GENERIC_ENTRY_TICKET 門票
GENERIC_RECEIPT 收據
GENERIC_OTHER 其他類型

通知

表示物件是否需要啟用通知。我們只支援其中一項 ExpiryNotification/FutureNotification。expiryNotification 的優先順序高於 upcomingNotification。換句話說,如果已設定 expiryNotification,系統就會忽略 upcomingNotification 欄位。

JSON 表示法
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
欄位
expiryNotification

object (ExpiryNotification)

系統會在卡片到期前的特定時間觸發通知。

upcomingNotification

object (UpcomingNotification)

系統會在卡片可使用前的特定時間觸發通知。

ExpiryNotification

表示發卡機構希望 Google 錢包在卡片到期前的 2 天傳送到期通知。

JSON 表示法
{
  "enableNotification": boolean
}
欄位
enableNotification

boolean

表示物件是否需要啟用到期通知。

UpcomingNotification

表示發卡機構希望 Google 錢包在卡片生效/使用前 1 天,傳送即將到來的卡片生效通知。

JSON 表示法
{
  "enableNotification": boolean
}
欄位
enableNotification

boolean

表示物件是否需要啟用即將發出的通知。

方法

get

傳回具有指定物件 ID 的一般物件。

insert

插入具有指定 ID 和屬性的一般物件。

list

傳回指定核發機構 ID 的所有一般物件清單。

patch

更新指定物件 ID 參照的一般物件。

update

更新指定物件 ID 參照的一般物件。