資源:LoyaltyObject
JSON 表示法 |
---|
{ "kind": string, "classReference": { object ( |
欄位 | |
---|---|
kind |
表示資源的種類。值:固定字串 |
class |
父項類別的沿用欄位副本。這類欄位是在 GET 執行期間所擷取。 |
account |
會員帳戶持有人名稱,例如「王大明」。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。 |
account |
會員帳戶 ID。建議長度上限為 20 個字元。 |
loyalty |
會員獎勵點數標籤、餘額和類型。 |
linked |
與這張會員卡相連結的優惠物件清單。優惠物件必須已存在。 優惠物件 ID 應依循 issuer ID 的格式。identifier 的格式,其中前者是由 Google 核發,後者則由您指定。 |
secondary |
次要會員獎勵點數標籤、餘額和類型,會與主要會員點數一併顯示。 |
id |
必要欄位。物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID 格式。identifier 的格式,其中前者是由 Google 核發,後者則由您指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。 |
class |
必要欄位。與這個物件相關聯的類別。必須是與這個物件同類型、已存在,並且經過核准的類別。 類別 ID 應依循 issuer ID 格式。identifier 的格式,其中前者是由 Google 核發,後者則由您指定。 |
version |
已淘汰 |
state |
必要欄位。物件的狀態。您可以使用這個欄位來設定物件在應用程式中的顯示情形。舉例來說, |
barcode |
條碼類型和值。 |
messages[] |
應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限是 10 個。 |
valid |
這個物件將處於 |
locations[] |
注意:系統目前不支援使用這個欄位觸發地理通知。 |
has |
表示這個物件是否有使用者。這個欄位是由平台所設定。 |
smart |
這個物件會透過 NFC 傳送至智慧感應認證感應式刷卡機的值。類別層級欄位 如果未設定這個值,但已正確設定類別層級欄位 |
has |
表示這個物件目前是否已連結至某部裝置。當使用者儲存物件以將物件連結到裝置時,平台會設定這個欄位。適用於特定合作夥伴。詳情請洽詢支援團隊。 |
disable |
表示是否應明確封鎖通知。如果將這個欄位設為 true,無論 目前只能針對優惠進行設定。 |
info |
已淘汰,請改用 textModulesData。 |
image |
圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個,以及類別物件層級 1 個。 |
text |
文字模組資料。如果類別中也定義了文字模組資料,則兩項資料都會顯示。這類欄位的顯示數量上限為來自物件的 10 個,以及來自類別的 10 個。 |
links |
連結模組資料。如果類別中也定義了連結模組資料,則兩項資料都會顯示。 |
app |
應用程式或網站連結 (選用) 會顯示為票證正面按鈕。如果為對應的類別提供 AppLinkData,系統只會顯示物件 AppLinkData。 |
rotating |
旋轉的條碼類型和值。 |
hero |
顯示在卡片正面的選用橫幅圖片。如果沒有,則會顯示類別的主頁橫幅 (如有)。如果類別也沒有主頁橫幅圖片,系統就不會顯示任何圖片。 |
grouping |
用於控管票證分組方式的資訊。 |
pass |
傳遞物件的限制條件。包括限制 NFC 和螢幕截圖行為。 |
save |
使用者嘗試儲存票證前,需要驗證的物件限制。請注意,這項限制只會在儲存時間期間套用。如果使用者儲存票證後,限制條件有所變更,系統不會將新限制套用至已儲存的票證。 |
linked |
linkedObjectIds 是其他物件的清單,例如活動票券、會員方案、優惠、一般、禮物卡、大眾運輸和登機證,這些物件應自動附加至此會員方案物件。如果使用者已儲存這張會員卡,系統會自動將這些 linkedObjectId 推送至使用者的錢包 (除非使用者關閉接收這類連結票證的設定)。 請確認已插入 linkedObjectIds 中的物件,否則呼叫會失敗。連結一經建立,就無法取消連結。您無法連結屬於其他發卡機構的物件。單一物件可連結的物件數量有限。達到上限後,系統會以無通知的方式忽略呼叫中的新連結物件。 物件 ID 應採用 issuer ID 格式。identifier 的格式,其中前者是由 Google 核發,後者則由您指定。 |
notify |
此物件的欄位更新是否應觸發通知。如果設為 NOTIFY,我們會嘗試觸發向使用者發出欄位更新通知。只有在欄位屬於許可清單的一部分時,系統才會傳送這些通知給使用者。如果設為「DO_NOT_NOTIFY」或「NOTIFICATION_SETTINGS_UNSPECIFIED」,則不會觸發任何通知。這項設定是暫時性的,需要在每次 PATCH 或 UPDATE 要求中設定,否則系統不會觸發通知。 |
value |
選用值新增模組資料。物件上最多可有十個。 |
LoyaltyPoints
JSON 表示法 |
---|
{ "label": string, "balance": { object ( |
欄位 | |
---|---|
label |
會員點數標籤,例如「點數」。建議長度上限為 9 個字元。 |
balance |
帳戶持有人的會員點數餘額,例如「500」或「$10.00」。建議長度上限為 7 個字元。這是 |
localized |
標籤的翻譯字串。建議長度上限為 9 個字元。 |
LoyaltyPointsBalance
JSON 表示法 |
---|
{
"string": string,
"int": integer,
"double": number,
"money": {
object ( |
欄位 | |
---|---|
string |
餘額的字串形式。請只填入其中一個子類型 (string、int、double、money)。 |
int |
餘額的整數形式。請只填入其中一個子類型 (string、int、double、money)。 |
double |
餘額的雙精度浮點數形式。請只填入其中一個子類型 (string、int、double、money)。 |
money |
餘額的金額形式。字串、整數、雙精度浮點數、金額等子類型只能填入其中一種。 |
方法 |
|
---|---|
|
新增訊息至指定物件 ID 參照的會員物件。 |
|
傳回具有指定物件 ID 的會員物件。 |
|
插入具有指定 ID 和屬性的會員物件。 |
|
傳回指定發卡機構 ID 的所有會員物件清單。 |
|
針對具有指定 ID 的會員物件修改已連結的優惠物件。 |
|
更新指定物件 ID 參照的會員物件。 |
|
更新指定物件 ID 參照的會員物件。 |