索引
EventTicketClassService
(介面)EventTicketObjectService
(介面)EventDateTime
(訊息)EventDateTime.DoorsOpenLabel
(列舉)EventReservationInfo
(訊息)EventSeat
(訊息)EventTicketClass
(訊息)EventTicketClass.ConfirmationCodeLabel
(列舉)EventTicketClass.GateLabel
(列舉)EventTicketClass.RowLabel
(列舉)EventTicketClass.SeatLabel
(列舉)EventTicketClass.SectionLabel
(列舉)EventTicketClassAddMessageRequest
(訊息)EventTicketClassAddMessageResponse
(訊息)EventTicketClassGetRequest
(訊息)EventTicketClassInsertRequest
(訊息)EventTicketClassListRequest
(訊息)EventTicketClassListResponse
(訊息)EventTicketClassPatchRequest
(訊息)EventTicketClassUpdateRequest
(訊息)EventTicketObject
(訊息)EventTicketObjectAddMessageRequest
(訊息)EventTicketObjectAddMessageResponse
(訊息)EventTicketObjectGetRequest
(訊息)EventTicketObjectInsertRequest
(訊息)EventTicketObjectListRequest
(訊息)EventTicketObjectListResponse
(訊息)EventTicketObjectModifyLinkedOfferObjectsRequest
(訊息)EventTicketObjectPatchRequest
(訊息)EventTicketObjectUpdateRequest
(訊息)EventVenue
(訊息)
EventTicketClassService
AddMessage | |
---|---|
新增訊息至指定類別 ID 參照的活動票券類別。
|
Get | |
---|---|
傳回含有指定類別 ID 的活動票券類別。
|
Insert | |
---|---|
插入含有指定 ID 和屬性的活動票券類別。
|
List | |
---|---|
傳回指定核發機構 ID 的所有活動票券類別清單。
|
Patch | |
---|---|
更新指定類別 ID 參照的活動票券類別。這個方法支援 patch 語義。
|
Update | |
---|---|
更新指定類別 ID 參照的活動票券類別。
|
EventTicketObjectService
AddMessage | |
---|---|
在指定物件 ID 參照的活動票券物件中新增訊息。
|
Get | |
---|---|
傳回具有指定物件 ID 的活動票券物件。
|
Insert | |
---|---|
插入具有指定 ID 和屬性的活動票券物件。
|
List | |
---|---|
傳回指定核發機構 ID 的所有活動票券物件清單。
|
ModifyLinkedOfferObjects | |
---|---|
針對具有指定 ID 的活動票券物件修改已連結的優惠物件。
|
Patch | |
---|---|
更新指定物件 ID 參照的活動票券物件。這個方法支援 patch 語義。
|
Update | |
---|---|
更新指定物件 ID 參照的活動票券物件。
|
EventDateTime
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
doors_open |
開放進場的日期/時間。 日期/時間採用 ISO 8601 擴充格式 (含或不含時差)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。 例如:
不含時差的日期/時間部分會被視為「當地日期/時間」,且應是活動場館的當地日期/時間。例如,如果活動在活動場館的 2018 年 6 月 5 日 20 時舉辦,則當地日期/時間的部分應為 在沒有時差資訊的情況下,某些實用功能可能無法使用。 |
start |
活動開始的日期/時間。如果活動橫跨數天,則應為活動第一天的開始日期/時間。 日期/時間採用 ISO 8601 擴充格式 (含或不含時差)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。 例如:
不含時差的日期/時間部分會被視為「當地日期/時間」,且應是活動場館的當地日期/時間。例如,如果活動在活動場館的 2018 年 6 月 5 日 20 時舉辦,則當地日期/時間的部分應為 在沒有時差資訊的情況下,某些實用功能可能無法使用。 |
end |
活動結束的日期/時間。如果活動橫跨數天,則應為活動最後一天的結束日期/時間。 日期/時間採用 ISO 8601 擴充格式 (含或不含時差)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。 例如:
不含時差的日期/時間部分會被視為「當地日期/時間」,且應是活動場館的當地日期/時間。例如,如果活動在活動場館的 2018 年 6 月 5 日 20 時舉辦,則當地日期/時間的部分應為 在沒有時差資訊的情況下,某些實用功能可能無法使用。 |
doors_open_label |
要在卡片詳細資料檢視畫面上針對開放進場時間值 (
|
custom_doors_open_label |
要在卡片詳細資料檢視畫面上針對開放進場時間值 (
|
DoorsOpenLabel
列舉 | |
---|---|
DOORS_OPEN_LABEL_UNSPECIFIED |
|
DOORS_OPEN |
|
doorsOpen |
|
GATES_OPEN |
|
gatesOpen |
|
EventReservationInfo
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
confirmation_code |
預訂活動的確認碼。這個值也可以採用「訂單編號」、「確認編號」、「預訂編號」或其他同等項目的形式。 |
EventSeat
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
seat |
座位的編號,例如「1」、「2」、「3」或其他座位 ID。 這個欄位可本地化,因此您可以翻譯字詞,或將 ID 中的字元替換成其他字母。 |
row |
座位的排數,例如「1」、「E」、「BB」或「A5」。 這個欄位可本地化,因此您可以翻譯字詞,或將 ID 中的字元替換成其他字母。 |
section |
座位的分區,例如「121」。 這個欄位可本地化,因此您可以翻譯字詞,或將 ID 中的字元替換成其他字母。 |
gate |
票券持有人前往座位時應進入的閘門,例如「A」或「西側」。 這個欄位可本地化,因此您可以翻譯字詞,或將 ID 中的字元替換成其他字母。 |
Eventticketclass
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
event_name |
必要項目。活動名稱,例如「台中虎隊在台北獅隊主場的棒球賽」。 |
event_id |
活動的 ID。帳戶中每一個活動的 ID 都不得重複。如果使用者針對相同活動儲存多個票券,系統會使用這項資訊將票券分組。長度上限為 64 個字元。 如果提供這個屬性,票券分組作業將可穩定進行。請小心意外發生的衝突,避免將不應屬於同一組的票券分為一組。如果每項活動僅有一個類別,您可以直接將這個項目設為 如果未提供這個項目,平台將會嘗試使用其他資料為票券分組 (可能會有不穩定的情形)。 |
logo |
票券的標誌圖片。這張圖片會顯示在應用程式的卡片詳細資料檢視畫面中。 |
venue |
活動場館詳細資料。 |
date_time |
活動的日期和時間資訊。 |
confirmation_code_label |
要在卡片詳細資料檢視畫面上針對確認碼值 (
|
custom_confirmation_code_label |
要在卡片詳細資料檢視畫面上針對確認碼值 (
|
seat_label |
要在卡片詳細資料檢視畫面上針對座位值 (
|
custom_seat_label |
要在卡片詳細資料檢視畫面上針對座位值 (
|
row_label |
要在卡片詳細資料檢視畫面上針對排數值 (
|
custom_row_label |
要在卡片詳細資料檢視畫面上針對排數值 (
|
section_label |
要在卡片詳細資料檢視畫面上針對區域值 (
|
custom_section_label |
要在卡片詳細資料檢視畫面上針對區域值 (
|
gate_label |
要在卡片詳細資料檢視畫面上針對入口值 (
|
custom_gate_label |
要在卡片詳細資料檢視畫面上針對入口值 (
|
fine_print |
票券的附屬細則、條款或條件。 |
class_template_info |
類別顯示方式的範本資訊。如未設定,Google 會恢復為顯示一組預設的欄位。 |
id |
必要項目。類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
version |
已淘汰 |
issuer_name |
必要項目。發卡機構名稱。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。 |
messages[] |
應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限是 10 個。 |
allow_multiple_users_per_object |
已淘汰,請改用 |
homepage_uri |
應用程式首頁的 URI。在這個欄位填入 URI 所產生的行為與在 linksModuleData 填入 URI 相同 (顯示物件時,首頁的連結會顯示在通常視為物件 linksModuleData 區段的地方)。 |
locations[] |
|
review_status |
必要項目。類別的狀態。可以透過 insert、patch 或 update 的 API 呼叫,將這個欄位設定為 當類別處於發展階段時,這個欄位應保持為 如果您確認類別可供使用,則應將此欄位設為 更新已處於 |
review |
當類別被標示為 |
info_module_data |
已淘汰,請改用 textModulesData。 |
image_modules_data[] |
圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個,以及類別物件層級 1 個。 |
text_modules_data[] |
文字模組資料。如果類別中也定義了文字模組資料,則兩項資料都會顯示。這類欄位的顯示數量上限為來自物件的 10 個,以及來自類別的 10 個。 |
links_module_data |
連結模組資料。如果物件中也定義了連結模組資料,則兩項資料都會顯示。 |
redemption_issuers[] |
僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。 |
country_code |
國家/地區代碼,用於顯示卡片的國家/地區 (當使用者不在該國家/地區時),以及用於顯示本地化內容 (當沒有使用者語言代碼適用的內容時)。 |
hero_image |
顯示在卡片正面的選用橫幅圖片。如果未提供,就不會顯示任何圖片。圖片會以 100% 寛度顯示。 |
word_mark |
已淘汰。 |
enable_smart_tap |
僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。 |
hex_background_color |
卡片的背景顏色。如果未設定,將會使用主頁橫幅的主要顏色;如果未設定主頁橫幅,將會使用標誌的主要顏色。格式為 #rrggbb,其中 rrggbb 是採十六進位制的 RGB 三元組,例如 |
localized_issuer_name |
issuer_name 的翻譯字串。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。 |
multiple_devices_and_holders_allowed_status |
表示是否有多位使用者和多台裝置會儲存參照這個類別的同一個物件。 |
callback_options |
每當使用者儲存/刪除這個類別的物件時,可以使用這些回呼選項來回呼發卡機構。這個類別的所有物件都適用回呼功能。 |
ConfirmationCodeLabel
列舉 | |
---|---|
CONFIRMATION_CODE_LABEL_UNSPECIFIED |
|
CONFIRMATION_CODE |
|
confirmationCode |
|
CONFIRMATION_NUMBER |
|
confirmationNumber |
|
ORDER_NUMBER |
|
orderNumber |
|
RESERVATION_NUMBER |
|
reservationNumber |
|
GateLabel
列舉 | |
---|---|
GATE_LABEL_UNSPECIFIED |
|
GATE |
|
gate |
|
DOOR |
|
door |
|
ENTRANCE |
|
entrance |
|
RowLabel
列舉 | |
---|---|
ROW_LABEL_UNSPECIFIED |
|
ROW |
|
row |
|
SeatLabel
列舉 | |
---|---|
SEAT_LABEL_UNSPECIFIED |
|
SEAT |
|
seat |
|
SectionLabel
列舉 | |
---|---|
SECTION_LABEL_UNSPECIFIED |
|
SECTION |
|
section |
|
THEATER |
|
theater |
|
EventTicketClassAddMessageRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
add_message_request |
要求的內容。 |
EventTicketClassAddMessageResponse
欄位 | |
---|---|
resource |
更新的 EventTicketClass 資源。 |
EventTicketClassGetRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
EventTicketClassInsertRequest
欄位 | |
---|---|
resource |
要求的內容。 |
EventTicketClassListRequest
欄位 | |
---|---|
issuer_id |
獲授權可列出類別的核發機構 ID。 |
token |
如有指定 |
max_results |
表示清單傳回的結果數量上限。如未定義 |
EventTicketClassListResponse
欄位 | |
---|---|
resources[] |
與清單要求相對應的資源。 |
pagination |
回應的分頁。 |
EventTicketClassPatchRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
EventTicketClassUpdateRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
EventTicketObject
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
class_reference |
父項類別的沿用欄位副本。這類欄位是在 GET 執行期間擷取的。 |
seat_info |
這張票券的座位詳細資料。 |
reservation_info |
這張票券的預訂詳細資料。一般情況下,只要是在同一筆訂單中購買的票券,其預訂詳細資料都相同。 |
ticket_holder_name |
票券持有人的姓名 (如果票券已指派給某人)。例如「陳大明」或「張小美」。 |
ticket_number |
票券的編號。這個值可以是發卡機構系統的票券專屬 ID、活動的票券專屬 ID (例如 XYZ1234512345),或訂單中的票券專屬 ID (1、2、3 等等)。 |
ticket_type |
票券的類型,例如「成人」或「孩童」,或是「貴賓」或「標準」。 |
face_value |
票券的面額,必須與實體票券上所列的金額相符。 |
grouping_info |
活動票券的分組資訊。 |
linked_offer_ids[] |
與此活動票券相連結的優惠物件清單。優惠物件必須已存在。 優惠物件 ID 應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。 |
id |
必要項目。物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
class_id |
必要項目。與這個物件相關聯的類別,必須是與這個物件同類型、已存在,並且經過核准的類別。 類別 ID 應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。 |
version |
已淘汰 |
state |
必要項目。物件的狀態。您可以使用這個欄位來設定物件在應用程式中的顯示情形。舉例來說, |
barcode |
條碼類型和值。 |
messages[] |
應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限是 10 個。 |
valid_time_interval |
這個物件處於 |
locations[] |
可以使用物件的位置清單。平台會使用這項資訊以觸發向使用者顯示的地理位置通知。請注意,物件中的位置會覆寫類別中的位置,類別中的位置會覆寫 Google 地方資訊 ID 中的位置。 |
has_users |
表示這個物件是否有使用者。這個欄位是由平台所設定。 |
smart_tap_redemption_value |
僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。 |
has_linked_device |
表示這個物件目前是否已連結至某部裝置。當使用者儲存物件以將物件連結到裝置時,平台會設定這個欄位。適用於特定合作夥伴。詳情請聯絡支援小組。 |
disable_expiration_notification |
表示是否應明確封鎖通知。如果將這個欄位設為 true,無論 目前此項目只能針對優惠進行設定。 |
info_module_data |
已淘汰,請改用 textModulesData。 |
image_modules_data[] |
圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個,以及類別物件層級 1 個。 |
text_modules_data[] |
文字模組資料。如果類別中也定義了文字模組資料,則兩項資料都會顯示。這類欄位的顯示數量上限為來自物件的 10 個,以及來自類別的 10 個。 |
links_module_data |
連結模組資料。如果類別中也定義了連結模組資料,則兩項資料都會顯示。 |
app_link_data |
合作夥伴應用程式連結的相關資訊 (選擇性)。 |
EventTicketObjectAddMessageRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
add_message_request |
要求的內容。 |
EventTicketObjectAddMessageResponse
欄位 | |
---|---|
resource |
更新的 EventTicketObject 資源。 |
EventTicketObjectGetRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
EventTicketObjectInsertRequest
欄位 | |
---|---|
resource |
要求的內容。 |
EventTicketObjectListRequest
欄位 | |
---|---|
class_id |
要列出其物件的類別 ID。 |
token |
如有指定 |
max_results |
表示清單傳回的結果數量上限。如未定義 |
EventTicketObjectListResponse
欄位 | |
---|---|
resources[] |
與清單要求相對應的資源。 |
pagination |
回應的分頁。 |
EventTicketObjectModifyLinkedOfferObjectsRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
modify_linked_offer_objects_request |
活動票券物件的優惠物件 ID。 |
EventTicketObjectPatchRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
EventTicketObjectUpdateRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
EventVenue
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
name |
活動場館的名稱,例如「台北市立棒球場」。 此為必要項目。 |
address |
活動場館的地址,例如「11153 台北市士林區\n忠誠路二段 77 號」。地址以換行字元 ( 此為必要項目。 |