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)
  }
}
欄位
kind
(deprecated)

string

標示資源的種類。值:固定字串 "walletobjects#eventTicketObject"

classReference

object (EventTicketClass)

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

seatInfo

object (EventSeat)

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

reservationInfo

object (EventReservationInfo)

這張票券的預訂詳細資料。這個值預計由在同一訂單購買的所有票券中共用。

ticketHolderName

string

票券持有人的姓名 (如果票券已指派給某人)。例如:「王志明」或「王小珍」。

ticketNumber

string

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

ticketType

object (LocalizedString)

票券的類型,例如「成人」或「貴子」或「VIP」或「標準」

faceValue

object (Money)

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

groupingInfo

object (GroupingInfo)

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

linkedOfferIds[]

string

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

優惠物件 ID 應採用下列格式:issuer IDidentifier 的格式,其中前者是由 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[]

object (LatLongPoint)

注意:這個欄位目前不支援觸發地理通知。

hasUsers

boolean

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

smartTapRedemptionValue

string

系統會針對這個物件,透過 NFC 傳輸到支援智慧感應功能的感應式刷卡機的值。類別層級的欄位 enableSmartTapredemptionIssuers 也必須正確設定,票證才能支援智慧感應功能。系統僅支援 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)

在使用者嘗試儲存票證前,必須驗證的物件限制。請注意,這項限制只適用於節省時間。如果在儲存票證後變更限制,新的限制就不會套用至已儲存的票證。

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 參照的活動票券物件。