索引
AddMessageRequest
(訊息)AppLinkData
(訊息)AppLinkData.AppLinkInfo
(訊息)AppLinkData.AppLinkInfo.AppTarget
(訊息)Barcode
(訊息)BarcodeRenderEncoding
(列舉)BarcodeType
(列舉)CallbackOptions
(訊息)DateTime
(訊息)DiscoverableProgram
(訊息)DiscoverableProgram.State
(列舉)DiscoverableProgramMerchantSigninInfo
(訊息)DiscoverableProgramMerchantSignupInfo
(訊息)DiscoverableProgramMerchantSignupInfo.SharedDataType
(列舉)GroupingInfo
(訊息)Image
(訊息)ImageModuleData
(訊息)ImageUri
(訊息)InfoModuleData
(訊息)LabelValue
(訊息)LabelValueRow
(訊息)LatLongPoint
(訊息)LinksModuleData
(訊息)LocalizedString
(訊息)Message
(訊息)Message.MessageType
(列舉)ModifyLinkedOfferObjects
(訊息)ModifyLinkedOfferObjectsRequest
(訊息)Money
(訊息)MultipleDevicesAndHoldersAllowedStatus
(列舉)Pagination
(訊息)Review
(訊息)ReviewStatus
(列舉)State
(列舉)TextModuleData
(訊息)TimeInterval
(訊息)TranslatedString
(訊息)Uri
(訊息)
AddMessageRequest
呼叫 AddMessage 端點時使用的資源。
欄位 | |
---|---|
message |
AppLinkData
欄位 | |
---|---|
android_app_link_info |
合作夥伴應用程式連結的相關資訊 (選擇性)。如有提供,應用程式連結模組會顯示在 Android 用戶端的有價值項目詳細資料上。 |
ios_app_link_info |
合作夥伴應用程式連結的相關資訊 (選擇性)。如有提供,應用程式連結模組會顯示在 iOS 用戶端的有價值項目詳細資料上。 |
web_app_link_info |
合作夥伴應用程式連結的相關資訊 (選擇性)。如有提供,應用程式連結模組會顯示在網路用戶端的有價值項目詳細資料上。 |
AppLinkInfo
欄位 | |
---|---|
app_logo_image |
要於應用程式連結模組中顯示的選用圖片 |
title |
要於應用程式連結模組標題中顯示的字串。必要項目。 |
description |
要於應用程式連結模組說明中顯示的字串。必要項目。 |
app_target |
在用戶端開啟應用程式連結模組時要前往的網址。合作夥伴會使用這個網址開啟自有網頁,或其應用程式的深層連結。 |
AppTarget
欄位 | |
---|---|
target_uri |
條碼
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
type |
條碼類型。 |
render_encoding |
條碼的轉譯編碼。如有指定,則會以指定的編碼轉譯條碼;如未指定,則由 Google 選擇最著名的編碼。 |
value |
條碼中的編碼值。 |
alternate_text |
選用文字,會覆寫條碼下方顯示的預設文字內容。這個欄位用於提供使用者能夠理解的條碼值對應內容,條碼無法掃描時即可派上用場。 |
show_code_text |
條碼為隱藏,需執行點擊動作才會顯示時,系統顯示的文字 (選擇性)。如果票證啟用智慧感應功能,就會發生這種情形。如未指定,則由 Google 選擇預設值。 |
BarcodeRenderEncoding
列舉 | |
---|---|
RENDER_ENCODING_UNSPECIFIED |
|
UTF_8 |
條碼的 UTF_8 編碼。這種編碼方式僅適用於 qrCode 條碼類型。 |
BarcodeType
列舉 | |
---|---|
BARCODE_TYPE_UNSPECIFIED |
|
AZTEC |
|
aztec |
|
CODE_39 |
|
code39 |
|
CODE_128 |
|
code128 |
|
CODABAR |
|
codabar |
|
DATA_MATRIX |
由黑白組成的二維矩陣條碼。單元或模組會以正方形或矩形排列。 |
dataMatrix |
|
EAN_8 |
|
ean8 |
|
EAN_13 |
|
ean13 |
|
EAN13 |
|
ITF_14 |
14 位數的 ITF 代碼 |
itf14 |
|
PDF_417 |
|
pdf417 |
|
PDF417 |
|
QR_CODE |
|
qrCode |
|
qrcode |
|
UPC_A |
11 或 12 位數的代碼 |
upcA |
|
TEXT_ONLY |
將欄位顯示為文字欄位。alternateText 欄位可能無法與 textOnly 類型的條碼搭配使用。 |
textOnly |
|
CallbackOptions
欄位 | |
---|---|
url |
由商家設定的 HTTPS 網址。網址必須以 HTTPS 進行代管,且 robots.txt 應允許 UserAgent:Google-Valuables 存取網址路徑。 |
DateTime
欄位 | |
---|---|
date |
採用 ISO 8601 擴充格式的日期/時間,不一定要含有偏移量 (請參閱父項欄位的說明文件)。時間的精確度可以指定到奈秒。此外,即使 ISO 8601 格式並未包含時差的秒數,時差的精確度仍可指定到秒。 例如:
如果提供時差,這個欄位在世界各處均指同一個絕對時間。系統會根據使用者的時區調整日期/時間。舉例來說, 如果省略時差,這個欄位則會顯示當地日期/時間,而這在世界各處代表多個不同的時間。日期/時間一律採用使用者目前所在的時區。比方說, |
DiscoverableProgram
如何在 Android Pay 應用程式中探索類別及為類別建立例項的相關資訊。這是透過搜尋會員方案或儲值卡方案,然後掃描或手動輸入來完成。
欄位 | |
---|---|
merchant_signup_info |
透過商家網站註冊方案並為該方案新增有價值項目之功能的相關資訊。使用時機為已啟用 MERCHANT_HOSTED_SIGNUP 時。 |
merchant_signin_info |
透過商家網站登入並為該方案新增有價值項目之功能的相關資訊。使用時機為已啟用 MERCHANT_HOSTED_SIGNIN 時。 |
state |
可探索方案的顯示狀態。 |
State
列舉 | |
---|---|
STATE_UNSPECIFIED |
|
TRUSTED_TESTERS |
只有可存取核發機構帳戶的測試人員才能看到。 |
trustedTesters |
|
LIVE |
所有使用者都能看到。 |
live |
|
DISABLED |
無法看到。 |
disabled |
|
DiscoverableProgramMerchantSigninInfo
某商家的代管方案登入流程相關資訊。
欄位 | |
---|---|
signin_website |
將使用者導向商家登入網站的網址。 |
DiscoverableProgramMerchantSignupInfo
某商家的代管方案註冊流程相關資訊。
欄位 | |
---|---|
signup_website |
將使用者導向商家註冊網站的網址。 |
signup_shared_datas[] |
在 POST 要求中傳送至註冊網站網址的使用者資料。這項資訊會先經過編碼再共用,因此商家網站可以預先填入欄位,以便讓使用者註冊可供搜索的方案。 |
GroupingInfo
NEXT_ID:2
欄位 | |
---|---|
sort_index |
當票證與其他票證一起分組時用來排序的選擇性索引。排序索引較低的票證會顯示在排序索引較高的票證之前。如未指定,系統會假定值為 INT_MAX;而對於具有相同排序索引的兩個票證,系統未定義其排序行為。 |
Image
Google 代管圖片的包裝類型。
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
source_uri |
圖片的 URI。 |
ImageModuleData
欄位 | |
---|---|
main_image |
100% 寛度的圖片。 |
id |
圖片模組的相關 ID。這個欄位可方便您管理圖片模組。 |
ImageUri
欄位 | |
---|---|
uri |
圖片的位置。必須定義 URI 配置。 |
description |
圖片的其他相關資訊,不使用且僅為回溯相容性而保留。 |
localized_description |
說明的翻譯字串,不使用且僅為回溯相容性而保留。 |
InfoModuleData
欄位 | |
---|---|
label_value_rows[] |
標籤和值的集合清單。這些項目會在單欄中逐一列出。 |
show_last_update_time |
|
LabelValue
詳細資料檢視畫面中顯示的一對字串。請注意,LabelValue/LabelValueRow 不再顯示為資料表,而是顯示為項目清單。
欄位 | |
---|---|
label |
特定列和欄的標籤。雙欄版面配置的建議上限為 15 個字元,單欄版面配置的建議上限則為 30 個字元。 |
value |
特定列和欄的值。雙欄版面配置的建議上限為 15 個字元,單欄版面配置的建議上限則為 30 個字元。 |
localized_label |
標籤的翻譯字串。雙欄版面配置的建議上限為 15 個字元,單欄版面配置的建議上限則為 30 個字元。 |
localized_value |
值的翻譯字串。雙欄版面配置的建議上限為 15 個字元,單欄版面配置的建議上限則為 30 個字元。 |
LabelValueRow
欄位 | |
---|---|
columns[] |
標籤和值的清單。這些項目會在單欄中逐一列出,而不會分別顯示在多欄中 (雖然欄位名稱看起來不是這個意思)。 |
LatLongPoint
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
latitude |
指定介於 -90.0 (含) 到 +90.0 (含) 之間的緯度。這個範圍以外的值會遭拒。 |
longitude |
指定介於 -180.0 (含) 到 +180.0 (含) 之間的經度。這個範圍以外的值會遭拒。 |
LinksModuleData
欄位 | |
---|---|
uris[] |
URI 清單。 |
LocalizedString
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
translated_values[] |
包含字串的翻譯。 |
default_value |
包含沒有適當翻譯時顯示的字串。 |
Message
隨重要資訊顯示的訊息
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
header |
訊息標頭。 |
body |
訊息內文。 |
display_interval |
向使用者顯示訊息的時間範圍。您可以定義各則訊息的 |
id |
與訊息相關的 ID。這個欄位可方便您管理訊息。請注意,同一類別/例項中的不同訊息可能會有重複的 ID 值,請仔細為各則訊息選取合理的 ID。 |
message_type |
訊息的類型。目前只能針對優惠進行設定。 |
localized_header |
訊息標頭的翻譯字串。 |
localized_body |
訊息內文的翻譯字串。 |
MessageType
列舉 | |
---|---|
MESSAGE_TYPE_UNSPECIFIED |
|
TEXT |
將訊息轉譯成文字並顯示於卡片資料畫面中。這是預設訊息類型。 |
text |
|
EXPIRATION_NOTIFICATION |
優惠到期顯示通知。displayInterval.start.date 是用來設定通知顯示的時間,最多可設定為到期日的前 30 天。如果指定的時間超過 30 天,通知觸發條件仍會設定在 30 天。 |
expirationNotification |
|
ModifyLinkedOfferObjects
欄位 | |
---|---|
add_linked_offer_object_ids[] |
要新增到物件中的已連結優惠物件 ID。 |
remove_linked_offer_object_ids[] |
要從物件中移除的已連結優惠物件 ID。 |
ModifyLinkedOfferObjectsRequest
欄位 | |
---|---|
linked_offer_object_ids |
要在物件中新增或移除的已連結優惠物件 ID。 |
Money
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
micros |
金額單位,以百萬分之一表示。例如 $1 美元會是 1000000 個百萬分之一。 |
currency_code |
貨幣代碼,例如「USD」或「EUR」。 |
MultipleDevicesAndHoldersAllowedStatus
列舉 | |
---|---|
STATUS_UNSPECIFIED |
|
MULTIPLE_HOLDERS |
允許多位使用者使用多部裝置。 |
multipleHolders |
|
ONE_USER_ALL_DEVICES |
允許一位使用者使用多部裝置。 |
oneUserAllDevices |
|
ONE_USER_ONE_DEVICE |
少數特殊情況下適用於特定合作夥伴。詳情請聯絡支援小組。 |
oneUserOneDevice |
|
Pagination
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
results_per_page |
此頁面中傳回的結果數量。 |
next_page_token |
傳送後可擷取下一頁結果的頁面符記。 |
Review
欄位 | |
---|---|
comments |
|
ReviewStatus
列舉 | |
---|---|
REVIEW_STATUS_UNSPECIFIED |
|
UNDER_REVIEW |
|
underReview |
|
APPROVED |
|
approved |
|
REJECTED |
|
rejected |
|
DRAFT |
|
draft |
|
State
列舉 | |
---|---|
STATE_UNSPECIFIED |
|
ACTIVE |
物件有效,並與其他有效物件一起顯示。 |
active |
|
COMPLETED |
|
completed |
|
EXPIRED |
物件已失效 (validTimeInterval 已過)。 |
expired |
|
INACTIVE |
|
inactive |
|
TextModuleData
文字模組的資料。所有欄位均為選填欄位。系統會顯示標頭 (如果有的話),並串連已定義的不同類型內文。
欄位 | |
---|---|
header |
文字模組的標頭。建議長度上限為 35 個字元,以確保在較小的螢幕上可顯示完整字串。 |
body |
文字模組的內文,定義為連續字串。建議長度上限為 500 個字元,以確保在較小的螢幕上可顯示完整字串。 |
localized_header |
標頭的翻譯字串。建議長度上限為 35 個字元,以確保在較小的螢幕上可顯示完整字串。 |
localized_body |
內文的翻譯字串。建議長度上限為 500 個字元,以確保在較小的螢幕上可顯示完整字串。 |
id |
文字模組的相關 ID。這個欄位可方便您管理文字模組。 |
TimeInterval
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
start |
有效時間範圍的開始時間。 不須提供時差。如已提供時差並設定 |
end |
有效時間範圍的結束時間。 不須提供時差。如已提供時差並設定 |
TranslatedString
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
language |
表示 BCP 47 語言標記。範例值:「en-US」、「en-GB」、「de」或「de-AT」。 |
value |
採 UTF-8 編碼的翻譯字串。 |
Uri
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
uri |
網頁、圖片或其他資源的位置。 |
description |
在應用程式中以文字顯示的 URI 標題。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。 請注意,在某些情況下,系統不會使用這串文字,例如當 |
localized_description |
說明的翻譯字串。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。 |
id |
URI 的相關 ID。這個欄位可方便您管理 URI。 |