google.walletobjects.v1.eventticket 套件

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

索引

EventTicketClassService

AddMessage

rpc AddMessage(EventTicketClassAddMessageRequest) returns (EventTicketClassAddMessageResponse)

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

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(EventTicketClassGetRequest) returns (EventTicketClass)

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

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(EventTicketClassInsertRequest) returns (EventTicketClass)

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

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(EventTicketClassListRequest) returns (EventTicketClassListResponse)

傳回指定核發機構 ID 的所有活動票券類別清單。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(EventTicketClassPatchRequest) returns (EventTicketClass)

更新指定類別 ID 參照的活動票券類別。這個方法支援 patch 語義。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(EventTicketClassUpdateRequest) returns (EventTicketClass)

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

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer

EventTicketObjectService

AddMessage

rpc AddMessage(EventTicketObjectAddMessageRequest) returns (EventTicketObjectAddMessageResponse)

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

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(EventTicketObjectGetRequest) returns (EventTicketObject)

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

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(EventTicketObjectInsertRequest) returns (EventTicketObject)

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

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(EventTicketObjectListRequest) returns (EventTicketObjectListResponse)

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

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
ModifyLinkedOfferObjects

rpc ModifyLinkedOfferObjects(EventTicketObjectModifyLinkedOfferObjectsRequest) returns (EventTicketObject)

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

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(EventTicketObjectPatchRequest) returns (EventTicketObject)

更新指定物件 ID 參照的活動票券物件。這個方法支援 patch 語義。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(EventTicketObjectUpdateRequest) returns (EventTicketObject)

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

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer

EventDateTime

欄位
kind
(deprecated)

string

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

doors_open

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 的時差。

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

doors_open_label

DoorsOpenLabel

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

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

custom_doors_open_label

LocalizedString

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

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

DoorsOpenLabel

列舉
DOORS_OPEN_LABEL_UNSPECIFIED
DOORS_OPEN
doorsOpen

DOORS_OPEN 的舊版別名,已淘汰。

GATES_OPEN
gatesOpen

GATES_OPEN 的舊版別名,已淘汰。

EventReservationInfo

欄位
kind
(deprecated)

string

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

confirmation_code

string

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

EventSeat

欄位
kind
(deprecated)

string

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

seat

LocalizedString

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

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

row

LocalizedString

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

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

section

LocalizedString

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

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

gate

LocalizedString

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

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

Eventticketclass

欄位
kind
(deprecated)

string

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

event_name

LocalizedString

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

event_id

string

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

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

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

venue

EventVenue

活動場館詳細資料。

date_time

EventDateTime

活動的日期和時間資訊。

confirmation_code_label

ConfirmationCodeLabel

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

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

custom_confirmation_code_label

LocalizedString

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

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

seat_label

SeatLabel

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

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

custom_seat_label

LocalizedString

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

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

row_label

RowLabel

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

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

custom_row_label

LocalizedString

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

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

section_label

SectionLabel

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

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

custom_section_label

LocalizedString

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

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

gate_label

GateLabel

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

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

custom_gate_label

LocalizedString

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

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

fine_print

LocalizedString

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

class_template_info

ClassTemplateInfo

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

id

string

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

version
(deprecated)

int64

已淘汰

issuer_name

string

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

messages[]

Message

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

allow_multiple_users_per_object
(deprecated)

bool

已淘汰,請改用 multipleDevicesAndHoldersAllowedStatus

homepage_uri

Uri

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

locations[]

LatLongPoint

review_status

ReviewStatus

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

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

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

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

review

Review

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

info_module_data
(deprecated)

InfoModuleData

已淘汰,請改用 textModulesData。

image_modules_data[]

ImageModuleData

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

text_modules_data[]

TextModuleData

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

redemption_issuers[]

int64

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

country_code

string

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

hero_image

Image

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

word_mark
(deprecated)

Image

已淘汰。

enable_smart_tap

bool

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

hex_background_color

string

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

localized_issuer_name

LocalizedString

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

multiple_devices_and_holders_allowed_status

MultipleDevicesAndHoldersAllowedStatus

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

callback_options

CallbackOptions

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

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 的舊版別名,已淘汰。

GateLabel

列舉
GATE_LABEL_UNSPECIFIED
GATE
gate

GATE 的舊版別名,已淘汰。

DOOR
door

DOOR 的舊版別名,已淘汰。

ENTRANCE
entrance

ENTRANCE 的舊版別名,已淘汰。

RowLabel

列舉
ROW_LABEL_UNSPECIFIED
ROW
row

ROW 的舊版別名,已淘汰。

SeatLabel

列舉
SEAT_LABEL_UNSPECIFIED
SEAT
seat

SEAT 的舊版別名,已淘汰。

SectionLabel

列舉
SECTION_LABEL_UNSPECIFIED
SECTION
section

SECTION 的舊版別名,已淘汰。

THEATER
theater

THEATER 的舊版別名,已淘汰。

EventTicketClassAddMessageRequest

欄位
resource_id

string

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

add_message_request

AddMessageRequest

要求的內容。

EventTicketClassAddMessageResponse

欄位
resource

EventTicketClass

更新的 EventTicketClass 資源。

EventTicketClassGetRequest

欄位
resource_id

string

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

EventTicketClassInsertRequest

欄位
resource

EventTicketClass

要求的內容。

EventTicketClassListRequest

欄位
issuer_id

int64

獲授權可列出類別的核發機構 ID。

token

string

如有指定 maxResults,但清單中的類別數量超過 maxResults,則可使用這個項目取得下一組結果。舉例來說,如果您有包含 200 個類別的清單,且您在呼叫清單時 maxResults 是設為 20,清單則會傳回前 20 個類別和一個符記。只要在 maxResults 設為 20 的情況下使用符記再次呼叫清單,即可取得接下來的 20 個類別。

max_results

int32

表示清單傳回的結果數量上限。如未定義 maxResults,則會傳回所有結果。

EventTicketClassListResponse

欄位
resources[]

EventTicketClass

與清單要求相對應的資源。

pagination

Pagination

回應的分頁。

EventTicketClassPatchRequest

欄位
resource_id

string

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

resource

EventTicketClass

要求的內容。

EventTicketClassUpdateRequest

欄位
resource_id

string

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

resource

EventTicketClass

要求的內容。

EventTicketObject

欄位
kind
(deprecated)

string

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

class_reference

EventTicketClass

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

seat_info

EventSeat

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

reservation_info

EventReservationInfo

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

ticket_holder_name

string

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

ticket_number

string

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

ticket_type

LocalizedString

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

face_value

Money

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

grouping_info

GroupingInfo

活動票券的分組資訊。

linked_offer_ids[]

string

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

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

id

string

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

class_id

string

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

類別 ID 應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。

version
(deprecated)

int64

已淘汰

state

State

必要項目。物件的狀態。您可以使用這個欄位來設定物件在應用程式中的顯示情形。舉例來說,inactive 物件會移至「過期的票證」區段。

barcode

Barcode

條碼類型和值。

messages[]

Message

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

valid_time_interval

TimeInterval

這個物件處於 active 狀態且可供使用的時間範圍。如果過了這段時間範圍,物件的狀態會變成 expired

locations[]

LatLongPoint

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

has_users

bool

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

smart_tap_redemption_value

string

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

has_linked_device

bool

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

disable_expiration_notification

bool

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

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

info_module_data

InfoModuleData

已淘汰,請改用 textModulesData。

image_modules_data[]

ImageModuleData

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

text_modules_data[]

TextModuleData

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

EventTicketObjectAddMessageRequest

欄位
resource_id

string

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

add_message_request

AddMessageRequest

要求的內容。

EventTicketObjectAddMessageResponse

欄位
resource

EventTicketObject

更新的 EventTicketObject 資源。

EventTicketObjectGetRequest

欄位
resource_id

string

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

EventTicketObjectInsertRequest

欄位
resource

EventTicketObject

要求的內容。

EventTicketObjectListRequest

欄位
class_id

string

要列出其物件的類別 ID。

token

string

如有指定 maxResults,但清單中的物件數量超過 maxResults,則可使用這個項目取得下一組結果。舉例來說,如果您有包含 200 個物件的清單,且您在呼叫清單時 maxResults 是設為 20,則清單會傳回前 20 個物件和一個符記。只要在 maxResults 設為 20 的情況下使用符記再次呼叫清單,即可取得接下來的 20 個物件。

max_results

int32

表示清單傳回的結果數量上限。如未定義 maxResults,則會傳回所有結果。

EventTicketObjectListResponse

欄位
resources[]

EventTicketObject

與清單要求相對應的資源。

pagination

Pagination

回應的分頁。

EventTicketObjectModifyLinkedOfferObjectsRequest

欄位
resource_id

string

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

modify_linked_offer_objects_request

ModifyLinkedOfferObjectsRequest

活動票券物件的優惠物件 ID。

EventTicketObjectPatchRequest

欄位
resource_id

string

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

resource

EventTicketObject

要求的內容。

EventTicketObjectUpdateRequest

欄位
resource_id

string

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

resource

EventTicketObject

要求的內容。

EventVenue

欄位
kind
(deprecated)

string

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

name

LocalizedString

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

此為必要項目。

address

LocalizedString

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

此為必要項目。