REST Resource: loyaltyclass

{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  }
}

string

識別資源的種類。值：固定字串 "walletobjects#loyaltyClass"。

string

必要欄位。方案名稱，例如「小明服飾」。應用程式可能會在前 20 個字元之後顯示刪節號，以確保在較小的螢幕上可顯示完整字串。

object (Image)

必要欄位。會員方案或公司的標誌。這個標誌會顯示在應用程式的詳細資料和清單檢視中。

string

帳戶名稱標籤，例如「會員名稱」。建議長度上限為 15 個字元，以確保在較小的螢幕上可顯示完整字串。

string

帳戶 ID 標籤，例如「會員 ID」。建議長度上限為 15 個字元，以確保在較小的螢幕上可顯示完整字串。

string

獎勵級別標籤，例如「獎勵級別」。建議長度上限為 9 個字元，以確保在較小的螢幕上可顯示完整字串。

string

獎勵級別，例如「金級」或「白金級」。建議長度上限為 7 個字元，以確保在較小的螢幕上可顯示完整字串。

object (LocalizedString)

programName 的翻譯字串。應用程式可能會在前 20 個字元之後顯示刪節號，以確保在較小的螢幕上可顯示完整字串。

object (LocalizedString)

accountNameLabel 的翻譯字串。建議長度上限為 15 個字元，以確保在較小的螢幕上可顯示完整字串。

object (LocalizedString)

accountIdLabel 的翻譯字串。建議長度上限為 15 個字元，以確保在較小的螢幕上可顯示完整字串。

object (LocalizedString)

獎勵 TierLabel 的翻譯字串。建議長度上限為 9 個字元，以確保在較小的螢幕上可顯示完整字串。

object (LocalizedString)

獎勵 Tier 的翻譯字串。建議長度上限為 7 個字元，以確保在較小的螢幕上可顯示完整字串。

string

次要獎勵級別標籤，例如「獎勵級別」。

object (LocalizedString)

secondaryRewardsTierLabel 的翻譯字串。

string

次要獎勵級別，例如「金級」或「白金級」。

object (LocalizedString)

secondaryRewardsTier 的翻譯字串。

object (DiscoverableProgram)

關於如何在 Google Pay 應用程式中探索類別及建立例項的相關資訊。

object (ClassTemplateInfo)

類別顯示方式的範本資訊。如未設定，Google 會改回顯示一組預設的顯示欄位。

string

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

string (int64 format)

已淘汰

string

必要欄位。核發者名稱。建議長度上限為 20 個字元，以確保在較小的螢幕上可顯示完整字串。

object (Message)

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

boolean

已淘汰，請改用 multipleDevicesAndHoldersAllowedStatus。

object (Uri)

應用程式首頁的 URI。在這個欄位中填入 URI 所產生的行為與在 linksModuleData 填入 URI 相同 (轉譯物件時，首頁的連結會顯示在通常視為物件 linksModuleData 區段的地方)。

object (LatLongPoint)

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

enum (ReviewStatus)

必要欄位。類別的狀態。可以透過插入、修補或更新 API 呼叫，將這個欄位設為 draft 或 underReview。一旦審查狀態從 draft 變更為其他狀態，就無法再變回 draft。

當類別處於開發階段時，您應將這個欄位保留為 draft。draft 類別無法用於建立任何物件。

如果您確認類別可供使用，則應將這個欄位設為 underReview。平台會自動將這個欄位設為 approved，這樣就能立即用來建立或遷移物件。

更新現有的 approved 類別時，請繼續將這個欄位設為 underReview。

object (Review)

類別標示為 approved 或 rejected 時，平台設定的審查留言。

object (InfoModuleData)

已淘汰，請改用 textModulesData。

object (ImageModuleData)

圖片模組資料。這類欄位數量上限為物件層級 1 個，以及類別物件層級 1 個。

object (TextModuleData)

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

object (LinksModuleData)

連結模組資料。如果物件中也定義了連結模組資料，則兩項資料都會顯示。

string (int64 format)

識別哪些兌換核發機構可透過智慧感應功能兌換票證。兌換核發機構是透過核發機構 ID 加以識別。兌換核發機構必須設定至少一個智慧感應功能。

此外，您也必須正確設定 enableSmartTap 和物件層級 smartTapRedemptionValue、barcode.value, oraccountId 欄位，才能讓票證支援智慧感應功能。

string

國家/地區代碼，用於顯示卡片的國家/地區 (當使用者不在該國家/地區時)，以及用於顯示本地化內容 (當沒有使用者語言代碼適用的內容時)。

object (Image)

顯示在資訊卡正面的選用橫幅圖片。如果沒有，就不會顯示任何項目。圖片會以 100% 的寬度顯示。

object (Image)

已淘汰。

boolean

判斷這個類別是否支援智慧感應功能。此外，您也必須正確設定 redemptionIssuers 和物件層級 smartTapRedemptionLevel、barcode.value, or accountId 欄位，才能讓票證支援智慧感應功能。

string

資訊卡的背景顏色。如未設定主頁橫幅的主要顏色，如果未設定主頁橫幅，將會使用標誌的主要顏色。格式為 #rrggbb，其中 rrggbb 是十六進位的 RGB 三元組，例如 #ffcc00。您也可以使用 RGB 三元組的簡寫版本 #rgb，例如 #fc0。

object (LocalizedString)

issuerName 的翻譯字串。建議長度上限為 20 個字元，以確保在較小的螢幕上可顯示完整字串。

enum (MultipleDevicesAndHoldersAllowedStatus)

表示是否有多位使用者和多部裝置會儲存參照這個類別的相同物件。

object (CallbackOptions)

使用者每次儲存/刪除這個類別的物件時，可以使用這些回呼選項來呼叫核發者。這個類別的所有物件都適用回呼功能。

object (SecurityAnimation)

選填的安全性動畫資訊。如果設定了這項政策，票證詳細資料上就會顯示安全性動畫。

enum (ViewUnlockRequirement)

查看會員卡的「解鎖規定」選項。

object (Image)

會員方案或公司的寬標誌。如有提供，系統就會取代資訊卡檢視畫面左上角的方案標誌。