REST 資源: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
  ],
  "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)
  }
}
欄位
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 核發,後者則由您指定。

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)

可以使用物件的位置清單。平台會使用這項資訊以觸發向使用者顯示的地理位置通知。請注意,物件中的位置會覆寫類別中的位置,類別中的位置會覆寫 Google 地方資訊 ID 中的位置。

hasUsers

boolean

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

smartTapRedemptionValue

string

僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。

hasLinkedDevice

boolean

表示這個物件目前是否已連結至某部裝置。當使用者儲存物件以將物件連結到裝置時,平台會設定這個欄位。適用於特定合作夥伴。詳情請聯絡支援小組。

disableExpirationNotification

boolean

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

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

infoModuleData

object (InfoModuleData)

已淘汰,請改用 textModulesData。

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

文字模組資料。如果類別中也定義了文字模組資料,則兩項資料都會顯示。這類欄位的顯示數量上限為來自物件的 10 個,以及來自類別的 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

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

GroupingInfo

NEXT_ID: 2

JSON 表示法

{
  "sortIndex": integer
}
欄位
sortIndex

integer

當票證與其他票證一起分組時用來排序的選擇性索引。排序索引較低的票證會顯示在排序索引較高的票證之前。如未指定,系統會假定值為 INT_MAX;而對於具有相同排序索引的兩個票證,系統未定義其排序行為。

方法

addmessage

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

get

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

insert

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

list

傳回指定發卡機構 ID 的完整活動票券物件清單。

modifylinkedofferobjects

針對有指定 ID 的活動票券物件修改附帶優惠物件。

patch

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

update

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