REST 資源:eventticketclass

資源:EventTicketClass

JSON 表示法

{
  "kind": string,
  "eventName": {
    object (LocalizedString)
  },
  "eventId": string,
  "logo": {
    object (Image)
  },
  "venue": {
    object (EventVenue)
  },
  "dateTime": {
    object (EventDateTime)
  },
  "confirmationCodeLabel": enum (ConfirmationCodeLabel),
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "seatLabel": enum (SeatLabel),
  "customSeatLabel": {
    object (LocalizedString)
  },
  "rowLabel": enum (RowLabel),
  "customRowLabel": {
    object (LocalizedString)
  },
  "sectionLabel": enum (SectionLabel),
  "customSectionLabel": {
    object (LocalizedString)
  },
  "gateLabel": enum (GateLabel),
  "customGateLabel": {
    object (LocalizedString)
  },
  "finePrint": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  }
}
欄位
kind
(deprecated)

string

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

eventName

object (LocalizedString)

必要項目。活動名稱,例如「台中虎隊在台北獅隊主場的棒球賽」。

eventId

string

活動的 ID。帳戶中每一個活動的 ID 都不得重複。如果使用者針對相同活動儲存多個票券,系統會使用這項資訊將票券分組。長度上限為 64 個字元。

如果提供這個屬性,票券分組作業將可穩定進行。請小心意外發生的衝突,避免將不應屬於同一組的票券分為一組。如果每項活動僅有一個類別,您可以直接將這個項目設為 classId (無論是否包含發卡機構 ID 部分)。

如果未提供這個項目,平台將會嘗試使用其他資料為票券分組 (可能會有不穩定的情形)。

venue

object (EventVenue)

活動場館詳細資料。

dateTime

object (EventDateTime)

活動的日期和時間資訊。

confirmationCodeLabel

enum (ConfirmationCodeLabel)

要在卡片詳細資料檢視畫面上針對確認碼值 (eventTicketObject.reservationInfo.confirmationCode) 使用的標籤。每個可用的選項會對應到一組本地化字串,以便根據使用者的語言代碼顯示適當的翻譯。

confirmationCodeLabelcustomConfirmationCodeLabel 都可不予設定。如果這二者皆未設定,標籤將依預設使用已經過本地化的「確認碼」。如果未設定確認碼欄位,就不會使用這個標籤。

customConfirmationCodeLabel

object (LocalizedString)

要在卡片詳細資料檢視畫面上針對確認碼值 (eventTicketObject.reservationInfo.confirmationCode) 使用的自訂標籤。只有預設的「確認碼」標籤或其中一個 confirmationCodeLabel 選項不敷使用時,才應使用這個項目。

confirmationCodeLabelcustomConfirmationCodeLabel 都可不予設定。如果這二者皆未設定,標籤將依預設使用已經過本地化的「確認碼」。如果未設定確認碼欄位,就不會使用這個標籤。

seatLabel

enum (SeatLabel)

要在卡片詳細資料檢視畫面上針對座位值 (eventTicketObject.seatInfo.seat) 使用的標籤。每個可用的選項會對應到一組本地化字串,以便根據使用者的語言代碼顯示適當的翻譯。

seatLabelcustomSeatLabel 都可不予設定。如果這二者皆未設定,標籤將依預設使用已經過本地化的「座位」。如果未設定座位欄位,就不會使用這個標籤。

customSeatLabel

object (LocalizedString)

要在卡片詳細資料檢視畫面上針對座位值 (eventTicketObject.seatInfo.seat) 使用的自訂標籤。只有預設的「座位」標籤或其中一個 seatLabel 選項不敷使用時,才應使用這個自訂標籤。

seatLabelcustomSeatLabel 都可不予設定。如果這二者皆未設定,標籤將依預設使用已經過本地化的「座位」。如果未設定座位欄位,就不會使用這個標籤。

rowLabel

enum (RowLabel)

要在卡片詳細資料檢視畫面上針對排數值 (eventTicketObject.seatInfo.row) 使用的標籤。每個可用的選項會對應到一組本地化字串,以便根據使用者的語言代碼顯示適當的翻譯。

rowLabelcustomRowLabel 都可不予設定。如果這二者皆未設定,標籤將依預設使用已經過本地化的「排」。如果未設定排數欄位,就不會使用這個標籤。

customRowLabel

object (LocalizedString)

要在卡片詳細資料檢視畫面上針對排數值 (eventTicketObject.seatInfo.row) 使用的自訂標籤。只有預設的「排」標籤或其中一個 rowLabel 選項不敷使用時,才應使用這個屬性。

rowLabelcustomRowLabel 都可不予設定。如果這二者皆未設定,標籤將依預設使用已經過本地化的「排」。如果未設定排數欄位,就不會使用這個標籤。

sectionLabel

enum (SectionLabel)

要在卡片詳細資料檢視畫面上針對區域值 (eventTicketObject.seatInfo.section) 使用的標籤。每個可用的選項會對應到一組本地化字串,以便根據使用者的語言代碼顯示適當的翻譯。

sectionLabelcustomSectionLabel 都可不予設定。如果這二者皆未設定,標籤將依預設使用已經過本地化的「區域」。如果未設定區域欄位,就不會使用這個標籤。

customSectionLabel

object (LocalizedString)

要在卡片詳細資料檢視畫面上針對區域值 (eventTicketObject.seatInfo.section) 使用的自訂標籤。只有預設的「區域」標籤或其中一個 sectionLabel 選項不敷使用時,才應使用這個屬性。

sectionLabelcustomSectionLabel 都可不予設定。如果這二者皆未設定,標籤將依預設使用已經過本地化的「區域」。如果未設定區域欄位,就不會使用這個標籤。

gateLabel

enum (GateLabel)

要在卡片詳細資料檢視畫面上針對入口值 (eventTicketObject.seatInfo.gate) 使用的標籤。每個可用的選項會對應到一組本地化字串,以便根據使用者的語言代碼顯示適當的翻譯。

gateLabelcustomGateLabel 都可不予設定。如果這二者皆未設定,標籤將依預設使用已經過本地化的「入口」。如果未設定入口欄位,就不會使用這個標籤。

customGateLabel

object (LocalizedString)

要在卡片詳細資料檢視畫面上針對入口值 (eventTicketObject.seatInfo.gate) 使用的自訂標籤。只有預設的「入口」標籤或其中一個 gateLabel 選項不敷使用時,才應使用這個屬性。

gateLabelcustomGateLabel 都可不予設定。如果這二者皆未設定,標籤將依預設使用已經過本地化的「入口」。如果未設定入口欄位,就不會使用這個標籤。

finePrint

object (LocalizedString)

票券的附屬細則、條款或條件。

classTemplateInfo

object (ClassTemplateInfo)

類別顯示方式的範本資訊。如未設定,Google 會恢復為顯示一組預設的欄位。

id

string

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

version
(deprecated)

string (int64 format)

已淘汰

issuerName

string

必要項目。發卡機構名稱。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。

messages[]

object (Message)

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

allowMultipleUsersPerObject
(deprecated)

boolean

已淘汰,請改用 multipleDevicesAndHoldersAllowedStatus

homepageUri

object (Uri)

應用程式首頁的 URI。在這個欄位填入 URI 所產生的行為與在 linksModuleData 填入 URI 相同 (顯示物件時,首頁的連結會顯示在通常視為物件 linksModuleData 區段的地方)。

locations[]

object (LatLongPoint)

reviewStatus

enum (ReviewStatus)

必要項目。類別的狀態。可以透過 insert、patch 或 update 的 API 呼叫,將這個欄位設定為 draftunderReview。一旦審查狀態從 draft 變更為其他狀態,就無法再變回 draft

當類別處於發展階段時,這個欄位應保持為 draftdraft 類別無法用於建立任何物件。

如果您確認類別可供使用,則應將此欄位設為 underReview。平台會自動將此欄位設為 approved,這樣就能立即用以建立或遷移物件。

更新已處於 approved 的類別時,請繼續將這個欄位設為 underReview

review

object (Review)

當類別被標示為 approvedrejected 時,平台所設定的審查留言。

infoModuleData
(deprecated)

object (InfoModuleData)

已淘汰,請改用 textModulesData。

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

redemptionIssuers[]

string (int64 format)

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

countryCode

string

國家/地區代碼,用於顯示卡片的國家/地區 (當使用者不在該國家/地區時),以及用於顯示本地化內容 (當沒有使用者語言代碼適用的內容時)。

heroImage

object (Image)

顯示在卡片正面的選用橫幅圖片。如果未提供,就不會顯示任何圖片。圖片會以 100% 寛度顯示。

wordMark
(deprecated)

object (Image)

已淘汰。

enableSmartTap

boolean

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

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

issuerName 的翻譯字串。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

表示是否有多位使用者和多台裝置會儲存參照這個類別的同一個物件。

callbackOptions

object (CallbackOptions)

每當使用者儲存/刪除這個類別的物件時,可以使用這些回呼選項來回呼發卡機構。這個類別的所有物件都適用回呼功能。

EventVenue

JSON 表示法

{
  "kind": string,
  "name": {
    object (LocalizedString)
  },
  "address": {
    object (LocalizedString)
  }
}
欄位
kind
(deprecated)

string

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

name

object (LocalizedString)

活動場館的名稱,例如「台北市立棒球場」。

此為必要項目。

address

object (LocalizedString)

活動場館的地址,例如「11153 台北市士林區\n忠誠路二段 77 號」。地址以換行字元 (\n) 分隔。

此為必要項目。

EventDateTime

JSON 表示法

{
  "kind": string,
  "doorsOpen": string,
  "start": string,
  "end": string,
  "doorsOpenLabel": enum (DoorsOpenLabel),
  "customDoorsOpenLabel": {
    object (LocalizedString)
  }
}
欄位
kind
(deprecated)

string

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

doorsOpen

string

開放進場的日期/時間。

日期/時間採用 ISO 8601 擴充格式 (含或不含時差)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。

例如:

1985-04-12T23:20:50.52Z 是世界標準時間 1985 年 4 月 12 日 23 時 20 分 50.52 秒。

1985-04-12T19:20:50.52-04:00 是 1985 年 4 月 12 日 19 時 20 分 50.52 秒,當地時間比世界標準時間慢 4 小時 (與上述範例為同一時間)。如果活動是在紐約舉行,則等同於美東夏令時間 (EDT)。請注意,時差可能會因當地當時是否施行日光節約時間 (或夏令時間) 而異。

1985-04-12T19:20:50.52 是 1985 年 4 月 12 日 19 時 20 分 50.52 秒,不含時差資訊。

不含時差的日期/時間部分會被視為「當地日期/時間」,且應是活動場館的當地日期/時間。例如,如果活動在活動場館的 2018 年 6 月 5 日 20 時舉辦,則當地日期/時間的部分應為 2018-06-05T20:00:00。如果活動場館的當地日期/時間比世界標準時間慢 4 小時,可以加上 -04:00 的時差。

在沒有時差資訊的情況下,某些實用功能可能無法使用。

start

string

活動開始的日期/時間。如果活動橫跨數天,則應為活動第一天的開始日期/時間。

日期/時間採用 ISO 8601 擴充格式 (含或不含時差)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。

例如:

1985-04-12T23:20:50.52Z 是世界標準時間 1985 年 4 月 12 日 23 時 20 分 50.52 秒。

1985-04-12T19:20:50.52-04:00 是 1985 年 4 月 12 日 19 時 20 分 50.52 秒,當地時間比世界標準時間慢 4 小時 (與上述範例為同一時間)。如果活動是在紐約舉行,則等同於美東夏令時間 (EDT)。請注意,時差可能會因當地當時是否施行日光節約時間 (或夏令時間) 而異。

1985-04-12T19:20:50.52 是 1985 年 4 月 12 日 19 時 20 分 50.52 秒,不含時差資訊。

不含時差的日期/時間部分會被視為「當地日期/時間」,且應是活動場館的當地日期/時間。例如,如果活動在活動場館的 2018 年 6 月 5 日 20 時舉辦,則當地日期/時間的部分應為 2018-06-05T20:00:00。如果活動場館的當地日期/時間比世界標準時間慢 4 小時,可以加上 -04:00 的時差。

在沒有時差資訊的情況下,某些實用功能可能無法使用。

end

string

活動結束的日期/時間。如果活動橫跨數天,則應為活動最後一天的結束日期/時間。

日期/時間採用 ISO 8601 擴充格式 (含或不含時差)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。

例如:

1985-04-12T23:20:50.52Z 是世界標準時間 1985 年 4 月 12 日 23 時 20 分 50.52 秒。

1985-04-12T19:20:50.52-04:00 是 1985 年 4 月 12 日 19 時 20 分 50.52 秒,當地時間比世界標準時間慢 4 小時 (與上述範例為同一時間)。如果活動是在紐約舉行,則等同於美東夏令時間 (EDT)。請注意,時差可能會因當地當時是否施行日光節約時間 (或夏令時間) 而異。

1985-04-12T19:20:50.52 是 1985 年 4 月 12 日 19 時 20 分 50.52 秒,不含時差資訊。

不含時差的日期/時間部分會被視為「當地日期/時間」,且應是活動場館的當地日期/時間。例如,如果活動在活動場館的 2018 年 6 月 5 日 20 時舉辦,則當地日期/時間的部分應為 2018-06-05T20:00:00。如果活動場館的當地日期/時間比世界標準時間慢 4 小時,可以加上 -04:00 的時差。

在沒有時差資訊的情況下,某些實用功能可能無法使用。

doorsOpenLabel

enum (DoorsOpenLabel)

要在卡片詳細資料檢視畫面上針對開放進場時間值 (doorsOpen) 使用的標籤。每個可用的選項會對應到一組本地化字串,以便根據使用者的語言代碼顯示適當的翻譯。

doorsOpenLabelcustomDoorsOpenLabel 都可不予設定。如果這二者皆未設定,標籤將依預設使用已經過本地化的「開放進場時間」。如果未設定開放進場時間欄位,就不會使用這個標籤。

customDoorsOpenLabel

object (LocalizedString)

要在卡片詳細資料檢視畫面上針對開放進場時間值 (doorsOpen) 使用的自訂標籤。只有預設的「開放進場時間」標籤或其中一個 doorsOpenLabel 選項不敷使用時,才應使用這個項目。

doorsOpenLabelcustomDoorsOpenLabel 都可不予設定。如果這二者皆未設定,標籤將依預設使用已經過本地化的「開放進場時間」。如果未設定開放進場時間欄位,就不會使用這個標籤。

DoorsOpenLabel

列舉
DOORS_OPEN_LABEL_UNSPECIFIED
DOORS_OPEN
doorsOpen

DOORS_OPEN 的舊版別名,已淘汰。

GATES_OPEN
gatesOpen

GATES_OPEN 的舊版別名,已淘汰。

ConfirmationCodeLabel

列舉
CONFIRMATION_CODE_LABEL_UNSPECIFIED
CONFIRMATION_CODE
confirmationCode

CONFIRMATION_CODE 的舊版別名,已淘汰。

CONFIRMATION_NUMBER
confirmationNumber

CONFIRMATION_NUMBER 的舊版別名,已淘汰。

ORDER_NUMBER
orderNumber

ORDER_NUMBER 的舊版別名,已淘汰。

RESERVATION_NUMBER
reservationNumber

RESERVATION_NUMBER 的舊版別名,已淘汰。

SeatLabel

列舉
SEAT_LABEL_UNSPECIFIED
SEAT
seat

SEAT 的舊版別名,已淘汰。

RowLabel

列舉
ROW_LABEL_UNSPECIFIED
ROW
row

ROW 的舊版別名,已淘汰。

SectionLabel

列舉
SECTION_LABEL_UNSPECIFIED
SECTION
section

SECTION 的舊版別名,已淘汰。

THEATER
theater

THEATER 的舊版別名,已淘汰。

GateLabel

列舉
GATE_LABEL_UNSPECIFIED
GATE
gate

GATE 的舊版別名,已淘汰。

DOOR
door

DOOR 的舊版別名,已淘汰。

ENTRANCE
entrance

ENTRANCE 的舊版別名,已淘汰。

方法

addmessage

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

get

傳回有指定類別 ID 的活動票券類別。

insert

插入有指定 ID 和屬性的活動票券類別。

list

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

patch

更新指定類別 ID 參照的活動票券類別。

update

更新指定類別 ID 參照的活動票券類別。