資源:GiftCardObject
JSON 表示法 |
---|
{ "kind": string, "classReference": { object ( |
欄位 | |
---|---|
kind |
識別資源的種類。值:固定字串 |
classReference |
父項類別的沿用欄位副本。這類欄位是在 GET 執行期間擷取。 |
cardNumber |
必要欄位。卡片號碼。 |
pin |
卡片 PIN 碼。 |
balance |
卡片餘額。 |
balanceUpdateTime |
餘額上次更新的日期和時間。 必須提供偏移。 如果餘額已更新且未提供這項屬性,系統預設會採用目前時間。 |
eventNumber |
卡片活動編號,此為選填欄位,供某些禮物卡使用。 |
id |
必要欄位。物件的專屬 ID。特定核發者的所有物件 ID 都不得重複。這個值應採用以下格式:issuer ID。identifier,其中前者是由 Google 核發,後者則您指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
classId |
必要欄位。與這個物件相關聯的類別。必須是與這個物件相同的類型、已存在,而且必須經過核准的類別。 類別 ID 應採用以下格式:issuer ID。identifier,其中前者是由 Google 核發,後者則您指定。 |
version |
已淘汰 |
state |
必要欄位。物件狀態。這個欄位可用來判斷物件在應用程式中的顯示方式。舉例來說, |
barcode |
條碼類型和值。 |
messages[] |
應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限為 10 個。 |
validTimeInterval |
這個物件處於 |
locations[] |
注意:這個欄位目前不支援觸發地理通知。 |
hasUsers |
指出這個物件是否有使用者。這個欄位是由平台設定。 |
smartTapRedemptionValue |
系統會透過 NFC 為這個物件傳輸透過智慧感應功能認證的感應式刷卡機。此外,類別層級 |
hasLinkedDevice |
這個物件目前是否已連結至單一裝置。當使用者儲存物件,並將物件連結到裝置時,平台會設定這個欄位。適用於特定合作夥伴。詳情請洽詢支援團隊。 |
disableExpirationNotification |
指出是否應明確抑制通知。如果將這個欄位設為 true,無論 目前只能針對優惠進行設定。 |
infoModuleData |
已淘汰,請改用 textModulesData。 |
imageModulesData[] |
圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個,以及類別物件層級 1 個。 |
textModulesData[] |
文字模組資料。如果類別中也定義了文字模組資料,則兩項資料都會顯示。這類欄位的顯示數量上限為物件中的 10 個,以及類別中的 10 個。 |
linksModuleData |
連結模組資料。如果類別中也定義了連結模組資料,則兩項資料都會顯示。 |
appLinkData |
選用的應用程式或網站連結,會顯示在票證正面的按鈕中。如果為對應的類別提供 AppLinkData,系統就會顯示 AppLinkData。 |
rotatingBarcode |
旋轉的條碼類型和值。 |
heroImage |
顯示在資訊卡正面的選用橫幅圖片。如果沒有,則會顯示類別的主頁橫幅 (如有)。如果缺少類別的主頁橫幅,就不會顯示任何訊息。 |
groupingInfo |
控管票證分組方式的資訊。 |
passConstraints |
傳遞物件的限制條件。包括限制 NFC 和螢幕截圖的行為。 |
方法 |
|
---|---|
|
在指定物件 ID 參照的禮物卡物件中新增訊息。 |
|
傳回具有指定物件 ID 的禮物卡物件。 |
|
插入具有指定 ID 和屬性的禮物卡物件。 |
|
傳回指定核發者 ID 的所有禮物卡物件清單。 |
|
更新指定物件 ID 參照的禮物卡物件。 |
|
更新指定物件 ID 參照的禮物卡物件。 |