本頁面由 Cloud Translation API 翻譯而成。

REST Resource: giftcardclass

資源：GiftCardClass
- JSON 表示法
方法

資源：GiftCardClass

JSON 表示法

JSON 表示法
{ "kind": string, "merchantName": string, "programLogo": { object (`Image`) }, "pinLabel": string, "eventNumberLabel": string, "allowBarcodeRedemption": boolean, "localizedMerchantName": { object (`LocalizedString`) }, "localizedPinLabel": { object (`LocalizedString`) }, "localizedEventNumberLabel": { object (`LocalizedString`) }, "cardNumberLabel": string, "localizedCardNumberLabel": { object (`LocalizedString`) }, "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`) }, "notifyPreference": enum (`NotificationSettingsForUpdates`), "appLinkData": { object (`AppLinkData`) }, "valueAddedModuleData": [ { object (`ValueAddedModuleData`) } ] }

{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    object (LocalizedString)
  },
  "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)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

欄位
`kind (deprecated)`	`string` 這個項目已遭淘汰！識別資源的種類。值：固定字串 `"walletobjects#giftCardClass"`。
`merchantName`	`string` 商家名稱，例如「小明服飾店」。應用程式可能會在前 20 個字元之後顯示省略符號，以確保在較小的螢幕上可顯示完整字串。
`programLogo`	`object (Image)` 禮物卡方案或公司的標誌。這個標誌會顯示在應用程式的詳細資料和清單檢視畫面中。
`pinLabel`	`string` 用來表示 PIN 碼的標籤，例如「4 位數 PIN 碼」。
`eventNumberLabel`	`string` 用來表示活動編號的標籤，例如「目標活動編號」。
`allowBarcodeRedemption`	`boolean` 決定商家是否支援使用條碼兌換禮物卡。如果值為 true，應用程式會在儲值卡詳細資料畫面上顯示儲值卡的條碼。如果值為 false，則不會顯示條碼。
`localizedMerchantName`	`object (LocalizedString)` merchantName 的翻譯字串。應用程式可能會在前 20 個字元之後顯示省略符號，以確保在較小的螢幕上可顯示完整字串。
`localizedPinLabel`	`object (LocalizedString)` pinLabel 的翻譯字串。
`localizedEventNumberLabel`	`object (LocalizedString)` eventNumberLabel 的翻譯字串。
`cardNumberLabel`	`string` 用來表示卡片號碼的標籤，例如「卡號」。
`localizedCardNumberLabel`	`object (LocalizedString)` cardNumberLabel 的翻譯字串。
`classTemplateInfo`	`object (ClassTemplateInfo)` 類別顯示方式的範本資訊。如未設定，Google 會改回顯示一組預設欄位。
`id`	`string` 必要欄位。類別的專屬 ID。這個 ID 不得與同一核發機構的其他類別 ID 相同。這個值應依循 `issuer ID` 格式。`identifier` 的格式，其中前者是由 Google 核發，後者則由您指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。
`version (deprecated)`	`string (int64 format)` 這個項目已遭淘汰！已淘汰
`issuerName`	`string` 必要欄位。發卡機構名稱。建議長度上限為 20 個字元，以確保在較小的螢幕上可顯示完整字串。
`messages[]`	`object (Message)` 應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限是 10 個。
`allowMultipleUsersPerObject (deprecated)`	`boolean` 這個項目已遭淘汰！已淘汰，請改用 `multipleDevicesAndHoldersAllowedStatus`。
`homepageUri`	`object (Uri)` 應用程式首頁的 URI。在這個欄位填入 URI 所產生的行為與在 linksModuleData 填入 URI 相同 (顯示物件時，首頁的連結會顯示在通常視為物件 linksModuleData 區段的地方)。
`locations[] (deprecated)`	`object (LatLongPoint)` 這個項目已遭淘汰！注意：系統目前不支援使用這個欄位觸發地理通知。
`reviewStatus`	`enum (ReviewStatus)` 必要欄位。課程的狀態。可以透過插入、修補或更新 API 呼叫的方式，將這個欄位設為 `draft` 或 `underReview`。一旦審查狀態從 `draft` 變更為其他狀態，就無法再變回 `draft`。類別仍在開發階段時，這個欄位應維持 `draft`。`draft` 類別無法用於建立任何物件。如果您確認類別可供使用，應將這個欄位設為 `underReview`。平台會自動將此欄位設為 `approved`，這樣就能立即用以建立或遷移物件。更新已處於 `approved` 的類別時，請繼續將這個欄位設為 `underReview`。
`review`	`object (Review)` 當類別標示為 `approved` 或 `rejected` 時，平台所設定的審查留言。
`infoModuleData (deprecated)`	`object (InfoModuleData)` 這個項目已遭淘汰！已淘汰，請改用 textModulesData。
`imageModulesData[]`	`object (ImageModuleData)` 圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個，以及類別物件層級 1 個。
`textModulesData[]`	`object (TextModuleData)` 文字模組資料。如果類別中也定義了文字模組資料，則兩項資料都會顯示。這類欄位的顯示數量上限為來自物件的 10 個，以及來自類別的 10 個。
`linksModuleData`	`object (LinksModuleData)` 連結模組資料。如果物件中也定義了連結模組資料，則兩項資料都會顯示。
`redemptionIssuers[]`	`string (int64 format)` 指出哪些兌換核發機構可透過智慧感應功能兌換票證。票證兌換機構 ID 可用於辨識票證兌換機構。兌換發放者必須設定至少一個智慧輕觸按鍵。 `enableSmartTap`和物件層級`smartTapRedemptionLevel`欄位也必須正確設定，票證才能支援智慧感應功能。
`countryCode`	`string` 國家/地區代碼，用於顯示卡片的國家/地區 (當使用者不在該國家/地區時)，以及用於顯示本地化內容 (當沒有使用者語言代碼適用的內容時)。
`heroImage`	`object (Image)` 顯示在卡片正面的選用橫幅圖片。如果未提供，就不會顯示任何圖片。圖片會以 100% 寬度顯示。
`wordMark (deprecated)`	`object (Image)` 這個項目已遭淘汰！已淘汰。
`enableSmartTap`	`boolean` 識別這個類別是否支援智慧感應功能。`redemptionIssuers` 和物件層級 `smartTapRedemptionLevel` 欄位也必須正確設定，才能讓票證支援智慧感應功能。
`hexBackgroundColor`	`string` 卡片的背景顏色。如果未設定，系統會使用主頁橫幅的主要顏色；如果未設定主頁橫幅，系統會使用標誌的主要顏色。格式為 #`rrggbb`，其中 `rrggbb` 是採十六進位制的 RGB 三位元組，例如 `#ffcc00`。您也可以使用 RGB 三元組的簡寫版本 #`rgb`，例如 `#fc0`。
`localizedIssuerName`	`object (LocalizedString)` issuerName 的翻譯字串。建議長度上限為 20 個字元，以確保在較小的螢幕上可顯示完整字串。
`multipleDevicesAndHoldersAllowedStatus`	`enum (MultipleDevicesAndHoldersAllowedStatus)` 表示是否有多位使用者和多台裝置會儲存參照這個類別的相同物件。
`callbackOptions`	`object (CallbackOptions)` 使用者每次儲存/刪除這個類別的物件時，都可以使用這些回呼選項來回呼發卡機構。這個類別的所有物件都適用回呼功能。
`securityAnimation`	`object (SecurityAnimation)` 安全防護動畫的相關資訊 (選填)。如果設定此屬性，票證詳細資料上會顯示安全性動畫。
`viewUnlockRequirement`	`enum (ViewUnlockRequirement)` 查看禮物卡的「解鎖條件」選項。
`wideProgramLogo`	`object (Image)` 禮物卡方案或公司的寬版標誌。提供這項資訊後，該標誌會取代資訊卡檢視畫面左上方的方案標誌。
`notifyPreference`	`enum (NotificationSettingsForUpdates)` 這個類別的欄位更新是否應觸發通知。如果設為 NOTIFY，我們會嘗試觸發向使用者發出欄位更新通知。只有在欄位屬於許可清單的一部分時，系統才會傳送這些通知給使用者。如未指定，系統就不會觸發任何通知。這項設定是暫時性的，需要在每次 PATCH 或 UPDATE 要求中設定，否則系統不會觸發通知。
`appLinkData`	`object (AppLinkData)` 應用程式或網站連結 (選用) 會顯示為票證正面按鈕。如果為相對應的物件提供 AppLinkData，系統會改用該物件。
`valueAddedModuleData[]`	`object (ValueAddedModuleData)` 選用值新增模組資料。每堂課最多可容納十位學生。對於通行證，系統只會顯示十個，並優先顯示物件中的通行證。

方法
`addmessage`	新增訊息至指定類別 ID 參照的儲值卡類別。
`get`	傳回具有指定類別 ID 的禮物卡類別。
`insert`	插入具有指定 ID 和屬性的儲值卡類別。
`list`	傳回指定發卡機構 ID 的完整儲值卡類別清單。
`patch`	更新指定類別 ID 參照的禮物卡類別。
`update`	更新指定類別 ID 參照的儲值卡類別。

REST Resource: giftcardclass

資源：GiftCardClass

方法

`addmessage`

`get`

`insert`

`list`

`patch`

`update`