REST Resource: genericobject

資源：GenericObject

一般物件

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,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
欄位
genericType

enum (GenericType)

指定卡片所屬的 GenericType。
cardTitle

object (LocalizedString)

必要欄位。憑證的標頭。通常是商家名稱，例如「XXX 健身房」、「AAA 保險」。這個欄位是必要欄位，會顯示在通行證最上方的標題列中。
subheader

object (LocalizedString)

票證的標題標籤，例如可使用此票證的位置。在票證詳細資料檢視畫面的標題列中，標題正上方會顯示此值。
header

object (LocalizedString)

必要欄位。票證的名稱，例如「50% 折扣優待券」或「圖書證」或「優待券」。這是必填欄位，會顯示在票證詳細資料檢視畫面的標題列中。
hexBackgroundColor

string

卡片的背景顏色。如果未設定，系統會使用主頁橫幅的主要顏色；如果未設定主頁橫幅，系統會使用標誌的主要顏色；如果未設定標誌，系統會選擇顏色。
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 傳送至智慧感應認證感應式刷卡機的值。如要讓票證支援智慧感應功能，您也必須正確設定類別層級欄位 enableSmartTap 和 redemptionIssuers。系統僅支援 ASCII 字元。
rotatingBarcode

object (RotatingBarcode)

旋轉條碼設定/詳細資料。
state

enum (State)

物件的狀態。您可以使用這個欄位來設定物件在應用程式中的顯示情形。舉例來說，inactive 物件會移至「過期的票證」區段。如未提供此值，系統會將物件視為 ACTIVE。
hasUsers

boolean

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

object (Message)

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

object (PassConstraints)

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

object (SaveRestrictions)

使用者嘗試儲存票證前，需要驗證的物件限制。請注意，這項限制只會在儲存時間期間套用。如果使用者儲存票證後，限制條件有所變更，系統不會將新限制套用至已儲存的票證。
valueAddedModuleData[]

object (ValueAddedModuleData)

選用價值加值模組資料。物件上最多可有十個。
linkedObjectIds[]

string

linkedObjectIds 是其他物件的清單，例如活動票券、會員卡、優惠、通用、禮物卡、大眾運輸和登機證，這些物件應自動附加至這個通用物件。如果使用者已儲存這張通用卡片，系統會自動將這些 linkedObjectId 推送至使用者的錢包 (除非使用者關閉接收這類已連結票證的設定)。

請確認已插入 linkedObjectIds 中的物件，否則呼叫會失敗。連結一經建立，就無法取消連結。您無法連結屬於其他發卡機構的物件。單一物件可連結的物件數量有限。達到上限後，系統會以無通知的方式忽略呼叫中的新連結物件。

物件 ID 應依循 issuer ID 的格式。identifier 的格式，其中前者是由 Google 核發，後者則由您指定。

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_LOYALTY_CARD 會員卡。請注意，建議您使用專屬的會員卡票證類型，而非這個通用類型。專屬的會員卡票證類型提供比通用票證類型更多的功能。
GENERIC_OTHER 其他類型

通知

表示物件是否需要啟用通知。我們只支援 ExpiryNotification/UpcomingNotification 其中一個。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

指出是否需要為物件啟用即將推出的通知。

方法

addmessage

 在指定物件 ID 參照的泛型物件中新增訊息。

get

 傳回具有指定物件 ID 的泛型物件。

insert

 插入具有指定 ID 和屬性的泛型物件。

list

 傳回指定發卡機構 ID 的所有泛型物件清單。

patch

 更新指定物件 ID 參照的泛型物件。

update

 更新指定物件 ID 參照的泛型物件。