REST Resource: loyaltyobject

資源：LoyaltyObject

JSON 表示法 
{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
欄位
kind
(deprecated)

string

表示資源的種類。值：固定字串 "walletobjects#loyaltyObject"。
classReference

object (LoyaltyClass)

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

string

會員帳戶持有人名稱，例如「王大明」。建議長度上限為 20 個字元，以確保在較小的螢幕上可顯示完整字串。
accountId

string

會員帳戶 ID。建議長度上限為 20 個字元。
loyaltyPoints

object (LoyaltyPoints)

會員獎勵點數標籤、餘額和類型。
linkedOfferIds[]

string

與這張會員卡相連結的優惠物件清單。優惠物件必須已存在。

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

object (LoyaltyPoints)

次要會員獎勵點數標籤、餘額和類型，會與主要會員點數一併顯示。
id

string

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

string

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

類別 ID 應遵循 issuer ID 的格式。identifier 的格式，其中前者是由 Google 核發，後者則由您指定。
version
(deprecated)

string (int64 format)

已淘汰
state

enum (State)

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

object (Barcode)

條碼類型和值。
messages[]

object (Message)

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

object (TimeInterval)

這個物件處於 active 狀態且可供使用的時間範圍。如果過了這段時間範圍，物件的狀態會變成 expired。
locations[]
(deprecated)

object (LatLongPoint)

注意：這個欄位目前不支援觸發地理通知。
hasUsers

boolean

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

string

這個物件會透過 NFC 傳送至智慧感應認證感應式刷卡機的值。類別層級欄位 enableSmartTap 和 redemptionIssuers 也必須正確設定，才能讓票證支援智慧感應功能。系統僅支援 ASCII 字元。

如果未設定這個值，但類別層級欄位 enableSmartTap 和 redemptionIssuers 的設定正確無誤，系統就會使用 barcode.value 或 accountId 欄位 (如有) 做為備用欄位。
hasLinkedDevice

boolean

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

boolean

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

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

object (InfoModuleData)

已淘汰，請改用 textModulesData。
imageModulesData[]

object (ImageModuleData)

圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個，類別物件層級則為 1 個。
textModulesData[]

object (TextModuleData)

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

object (RotatingBarcode)

旋轉條碼的類型和值。
heroImage

object (Image)

顯示在卡片正面的選用橫幅圖片。如果沒有，則會顯示類別的主頁橫幅 (如有)。如果類別也沒有主頁橫幅圖片，系統就不會顯示任何圖片。
groupingInfo

object (GroupingInfo)

用於控管票證分組方式的資訊。
passConstraints

object (PassConstraints)

傳遞物件的限制條件。包括限制 NFC 和螢幕截圖行為。
saveRestrictions

object (SaveRestrictions)

在使用者嘗試儲存票證前，必須驗證的物件限制。請注意，這項限制只會在儲存時間期間套用。如果在儲存票證後變更限制，新的限制就不會套用至已儲存的票證。
linkedObjectIds[]

string

linkObjectIds 是其他物件的清單，例如活動票券、會員、優惠、一般、禮物卡、大眾運輸和登機證，這類票證應會自動附加至這個會員物件。如果使用者已儲存這張會員卡，系統會自動將這些 linkedObjectId 推送至使用者的錢包 (除非使用者關閉接收這類連結票證的設定)。

請確認已插入 linkedObjectIds 中的物件，否則呼叫會失敗。連結後即無法取消連結。您無法連結屬於其他發卡機構的物件。單一物件可連結的物件數量有限。達到上限後，系統會以無通知的方式忽略呼叫中的新連結物件。

物件 ID 應採用 issuer ID 格式。identifier 的格式，其中前者是由 Google 核發，後者則由您指定。
notifyPreference

enum (NotificationSettingsForUpdates)

此物件的欄位更新是否應觸發通知。如果設為 NOTIFY，我們會嘗試觸發向使用者發出欄位更新通知。只有在欄位屬於許可清單的一部分時，系統才會傳送這些通知給使用者。如果設為 DO_NOT_NOTIFY 或 NOTIFICATION_SETTINGS_UNSPECIFIED，系統就不會觸發通知。這項設定是暫時性的，需要在每次 PATCH 或 UPDATE 要求中設定，否則系統不會觸發通知。
valueAddedModuleData[]

object (ValueAddedModuleData)

選用值新增模組資料。物件上最多可有十個。

LoyaltyPoints

JSON 表示法 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
欄位
label

string

會員點數標籤，例如「點數」。建議長度上限為 9 個字元。
balance

object (LoyaltyPointsBalance)

帳戶持有人的會員點數餘額，例如「500」或「$10.00 美元」。建議長度上限為 7 個字元。這是 loyaltyPoints 和 secondaryLoyaltyPoints 的必填欄位。
localizedLabel

object (LocalizedString)

標籤的翻譯字串。建議長度上限為 9 個字元。

LoyaltyPointsBalance

JSON 表示法 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
欄位
string

string

餘額的字串形式。字串、整數、雙精度浮點數、金額等子類型只能填入其中一種。
int

integer

餘額的整數形式。請只填入其中一個子類型 (string、int、double、money)。
double

number

餘額的雙精度浮點數形式。請只填入其中一個子類型 (string、int、double、money)。
money

object (Money)

餘額的金額形式。請只填入其中一個子類型 (string、int、double、money)。

方法

addmessage

 新增訊息至指定物件 ID 參照的會員物件。

get

 傳回具有指定物件 ID 的會員物件。

insert

 插入具有指定 ID 和屬性的會員物件。

list

 傳回指定核發機構 ID 的所有會員物件清單。

modifylinkedofferobjects

 針對具有指定 ID 的會員物件修改已連結的優惠物件。

patch

 更新指定物件 ID 參照的會員物件。

update

 更新指定物件 ID 參照的會員物件。