REST Resource: eventticketobject

資源：EventTicketObject

JSON 表示法 
{
  "kind": string,
  "classReference": {
    object (EventTicketClass)
  },
  "seatInfo": {
    object (EventSeat)
  },
  "reservationInfo": {
    object (EventReservationInfo)
  },
  "ticketHolderName": string,
  "ticketNumber": string,
  "ticketType": {
    object (LocalizedString)
  },
  "faceValue": {
    object (Money)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "linkedOfferIds": [
    string
  ],
  "hexBackgroundColor": string,
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
欄位
kind
(deprecated)

string

表示資源的種類。值：固定字串 "walletobjects#eventTicketObject"。
classReference

object (EventTicketClass)

父項類別的沿用欄位副本。這類欄位是在 GET 執行期間所擷取。
seatInfo

object (EventSeat)

這張票券的座位詳細資料。
reservationInfo

object (EventReservationInfo)

這張票券的預訂詳細資料。一般情況下，只要是在同一筆訂單中購買的票券，其預訂詳細資料都相同。
ticketHolderName

string

票券持有人的姓名 (如果票券已指派給某人)。例如「陳大明」或「張小美」。
ticketNumber

string

票券的編號。這個值可以是發卡機構系統的票券專屬 ID、活動的票券專屬 ID (例如 XYZ1234512345)，或訂單中的票券專屬 ID (1、2、3 等等)。
ticketType

object (LocalizedString)

票券的類型，例如「成人」或「孩童」，或是「貴賓」或「標準」。
faceValue

object (Money)

票券的面額，必須與實體票券上所列的金額相符。
groupingInfo

object (GroupingInfo)

控管票證分組方式的資訊。
linkedOfferIds[]

string

與此活動票券相連結的優惠物件清單。優惠物件必須已存在。

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

string

卡片的背景顏色。如果未設定，系統會使用主頁橫幅的主要顏色；如果未設定主頁橫幅，系統會使用標誌的主要顏色。格式為 #rrggbb，其中 rrggbb 是採十六進位制的 RGB 三位元組，例如 #ffcc00。您也可以使用 RGB 三位元組的簡寫版本 #rgb，例如 #fc0。
id

string

必要欄位。物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID 格式。identifier 的格式，其中前者是由 Google 核發，後者則由您指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。
classId

string

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

類別 ID 應依循 issuer ID 格式。identifier 的格式，其中前者是由 Google 核發，後者則由您指定。
version
(deprecated)

string (int64 format)

已淘汰
state

enum (State)

必要欄位。物件的狀態。這個欄位是用來決定物件在應用程式中的顯示方式。舉例來說，inactive 物件會移至「過期的票證」區段。
barcode

object (Barcode)

條碼類型和值。
messages[]

object (Message)

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

object (TimeInterval)

這個物件處於 active 狀態且可供使用的時間範圍。如果過了這段時間範圍，物件的狀態會變成 expired。
locations[]
(deprecated)

object (LatLongPoint)

注意：系統目前不支援使用這個欄位觸發地理通知。
hasUsers

boolean

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

string

這個物件會透過 NFC 傳送至智慧感應認證感應式刷卡機的值。類別層級欄位 enableSmartTap 和 redemptionIssuers 也必須正確設定，才能讓票證支援智慧感應功能。系統僅支援 ASCII 字元。
hasLinkedDevice

boolean

這個物件目前是否已連結至單一裝置。當使用者儲存物件以將物件連結到裝置時，平台會設定這個欄位。適用於特定合作夥伴。如需更多資訊，請與支援團隊聯絡。
disableExpirationNotification

boolean

指出是否應明確封鎖通知。如果將這個欄位設為 true，無論 messages 欄位的值為何，向使用者發出的到期通知都會遭封鎖。根據預設，這個欄位是設為 false。

目前只能針對優惠進行設定。
infoModuleData

object (InfoModuleData)

已淘汰，請改用 textModulesData。
imageModulesData[]

object (ImageModuleData)

圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個，以及類別物件層級 1 個。
textModulesData[]

object (TextModuleData)

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

object (RotatingBarcode)

旋轉的條碼類型和值。
heroImage

object (Image)

顯示在卡片正面的選用橫幅圖片。如果沒有，系統會顯示該類別的主頁橫幅圖片 (如果有)。如果該類別的主頁橫幅也未顯示，系統就不會顯示任何內容。
passConstraints

object (PassConstraints)

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

object (SaveRestrictions)

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

string

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

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

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

enum (NotificationSettingsForUpdates)

是否要針對這個物件更新欄位內容，是否應觸發通知。如果設為 NOTIFY，我們會嘗試觸發向使用者發出欄位更新通知。只有在欄位屬於許可清單的一部分時，系統才會傳送這些通知給使用者。如果設為「DO_NOT_NOTIFY」或「NOTIFICATION_SETTINGS_UNSPECIFIED」，則不會觸發任何通知。這是暫時性的設定，且必須為每個 PATCH 或 UPDATE 要求進行設置，否則不會觸發通知。
valueAddedModuleData[]

object (ValueAddedModuleData)

選用價值加值模組資料。物件最多只能有 10 個。

EventSeat

JSON 表示法 
{
  "kind": string,
  "seat": {
    object (LocalizedString)
  },
  "row": {
    object (LocalizedString)
  },
  "section": {
    object (LocalizedString)
  },
  "gate": {
    object (LocalizedString)
  }
}
欄位
kind
(deprecated)

string

表示資源的種類。值：固定字串 "walletobjects#eventSeat"。
seat

object (LocalizedString)

座位編號，例如「1」、「2」、「3」或其他座位 ID。

這個欄位可本地化，因此您可以翻譯字詞，或將 ID 中的字元替換成其他字母。
row

object (LocalizedString)

座位的排數，例如「1」、「E」、「BB」或「A5」。

這個欄位可本地化，因此您可以翻譯字詞，或將 ID 中的字元替換成其他字母。
section

object (LocalizedString)

座位的分區，例如「121」。

這個欄位可本地化，因此您可以翻譯字詞，或將 ID 中的字元替換成其他字母。
gate

object (LocalizedString)

票券持有人前往座位時應進入的閘門，例如「A」或「西側」。

這個欄位可本地化，因此您可以翻譯字詞，或將 ID 中的字元替換成其他字母。

EventReservationInfo

JSON 表示法 
{
  "kind": string,
  "confirmationCode": string
}
欄位
kind
(deprecated)

string

表示資源的種類。值：固定字串 "walletobjects#eventReservationInfo"。
confirmationCode

string

預訂活動的確認碼。這個值也可以採用「訂單編號」、「確認編號」、「預訂編號」或其他同等項目的形式。

方法

addmessage

 新增訊息至指定物件 ID 參照的活動票券物件。

get

 傳回具有指定物件 ID 的活動票券物件。

insert

 插入具有指定 ID 和屬性的活動票券物件。

list

 傳回指定核發者 ID 的所有活動票券物件清單。

modifylinkedofferobjects

 針對具有指定 ID 的活動票券物件修改已連結的優惠物件。

patch

 更新指定物件 ID 參照的活動票券物件。

update

 更新指定物件 ID 參照的活動票券物件。