索引
GiftCardClassService
(介面)GiftCardObjectService
(介面)GiftCardClass
(訊息)GiftCardClassAddMessageRequest
(訊息)GiftCardClassAddMessageResponse
(訊息)GiftCardClassGetRequest
(訊息)GiftCardClassInsertRequest
(訊息)GiftCardClassListRequest
(訊息)GiftCardClassListResponse
(訊息)GiftCardClassPatchRequest
(訊息)GiftCardClassUpdateRequest
(訊息)GiftCardObject
(訊息)GiftCardObjectAddMessageRequest
(訊息)GiftCardObjectAddMessageResponse
(訊息)GiftCardObjectGetRequest
(訊息)GiftCardObjectInsertRequest
(訊息)GiftCardObjectListRequest
(訊息)GiftCardObjectListResponse
(訊息)GiftCardObjectPatchRequest
(訊息)GiftCardObjectUpdateRequest
(訊息)
GiftCardClassService
AddMessage | |
---|---|
新增訊息至指定類別 ID 參照的儲值卡類別。
|
Get | |
---|---|
傳回具有指定類別 ID 的儲值卡類別。
|
Insert | |
---|---|
插入具有指定 ID 和屬性的儲值卡類別。
|
List | |
---|---|
傳回指定核發機構 ID 所有儲值卡類別的清單。
|
Patch | |
---|---|
更新指定類別 ID 參照的儲值卡類別。這個方法支援 patch 語義。
|
Update | |
---|---|
更新指定類別 ID 參照的儲值卡類別。
|
GiftCardObjectService
AddMessage | |
---|---|
在指定物件 ID 參照的儲值卡物件中新增訊息。
|
Get | |
---|---|
傳回具有指定物件 ID 的儲值卡物件。
|
Insert | |
---|---|
插入具有指定 ID 和屬性的儲值卡物件。
|
List | |
---|---|
傳回指定核發機構 ID 所有儲值卡物件的清單。
|
Patch | |
---|---|
更新指定物件 ID 參照的儲值卡物件。這個方法支援 patch 語義。
|
Update | |
---|---|
更新指定物件 ID 參照的儲值卡物件。
|
GiftCardClass
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
merchant_name |
商家名稱,例如「小明服飾店」。應用程式可能會在前 20 個字元之後顯示省略符號,以確保在較小的螢幕上可顯示完整字串。 |
program_logo |
儲值卡方案或公司的標誌。這個標誌會顯示在應用程式的詳細資料及清單檢視畫面中。 |
pin_label |
用來表示 PIN 碼的標籤,例如「4 位數 PIN 碼」。 |
event_number_label |
用來表示活動號碼的標籤,例如「目標活動號碼」。 |
allow_barcode_redemption |
決定商家是否支援使用條碼兌換儲值卡。如果值為 true,應用程式會在儲值卡詳細資料畫面上顯示儲值卡的條碼。如果值為 false,則不會顯示條碼。 |
localized_merchant_name |
merchant_name 的翻譯字串。應用程式可能會在前 20 個字元之後顯示省略符號,以確保在較小的螢幕上可顯示完整字串。 |
localized_pin_label |
pin_label 的翻譯字串。 |
localized_event_number_label |
event_number_label 的翻譯字串。 |
card_number_label |
用來表示卡片號碼的標籤,例如「卡號」。 |
localized_card_number_label |
card_number_label 的翻譯字串。 |
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[] |
可以使用物件的位置清單。平台會使用這項資訊以觸發向使用者顯示的地理位置通知。請注意,物件中的位置會覆寫類別中的位置,類別中的位置會覆寫 Google 地方資訊 ID 中的位置。 |
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 |
每當使用者儲存/刪除這個類別的物件時,可以使用這些回呼選項來回呼發卡機構。這個類別的所有物件都適用回呼功能。 |
GiftCardClassAddMessageRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
add_message_request |
要求的內容。 |
GiftCardClassAddMessageResponse
欄位 | |
---|---|
resource |
更新的 GiftCardClass 資源。 |
GiftCardClassGetRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
GiftCardClassInsertRequest
欄位 | |
---|---|
resource |
要求的內容。 |
GiftCardClassListRequest
欄位 | |
---|---|
issuer_id |
獲授權可列出類別的核發機構 ID。 |
token |
如有指定 |
max_results |
表示清單傳回的結果數量上限。如未定義 |
GiftCardClassListResponse
欄位 | |
---|---|
resources[] |
與清單要求相對應的資源。 |
pagination |
回應的分頁。 |
GiftCardClassPatchRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
GiftCardClassUpdateRequest
欄位 | |
---|---|
resource_id |
類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
GiftCardObject
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
class_reference |
父項類別的沿用欄位副本。這類欄位是在 GET 執行期間所擷取。 |
card_number |
必填欄位。卡片的號碼。 |
pin |
卡片的 PIN 碼。 |
balance |
卡片的餘額。 |
balance_update_time |
餘額上次更新的日期和時間。 必須提供偏移量。 如果餘額已更新且未提供這項屬性,系統預設會採用目前時間。 |
event_number |
卡片的活動號碼,此為選填欄位,供某些儲值卡使用。 |
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 |
合作夥伴應用程式連結的相關資訊 (選擇性)。 |
GiftCardObjectAddMessageRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
add_message_request |
要求的內容。 |
GiftCardObjectAddMessageResponse
欄位 | |
---|---|
resource |
更新的 GiftCardObject 資源。 |
GiftCardObjectGetRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
GiftCardObjectInsertRequest
欄位 | |
---|---|
resource |
要求的內容。 |
GiftCardObjectListRequest
欄位 | |
---|---|
class_id |
要列出其物件的類別 ID。 |
token |
如有指定 |
max_results |
表示清單傳回的結果數量上限。如未定義 |
GiftCardObjectListResponse
欄位 | |
---|---|
resources[] |
與清單要求相對應的資源。 |
pagination |
回應的分頁。 |
GiftCardObjectPatchRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |
GiftCardObjectUpdateRequest
欄位 | |
---|---|
resource_id |
物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
resource |
要求的內容。 |