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)
  }
}
欄位
kind
(deprecated)

string

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

object (LoyaltyClass)

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

string

會員帳戶持有人名稱，例如「John Smith」。建議長度上限為 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[]

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)

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

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

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

number

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

object (Money)

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

方法

addmessage

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

get

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

insert

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

list

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

modifylinkedofferobjects

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

patch

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

update

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