REST Resource: giftcardclass

{
  "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)
    }
  ]
}

string

ระบุว่านี่คือทรัพยากรประเภทใด ค่า: สตริงคงที่ "walletobjects#giftCardClass"

string

ชื่อผู้ขาย เช่น "Adam's Apparel" แอปอาจแสดงเครื่องหมายจุดประยอยต่อจากอักขระ 20 ตัวแรกเพื่อให้แน่ใจว่าสตริงจะแสดงอย่างเต็มรูปแบบบนหน้าจอขนาดเล็ก

object (Image)

โลโก้ของโปรแกรมหรือบริษัทบัตรของขวัญ โลโก้นี้จะแสดงทั้งในมุมมองรายละเอียดและมุมมองรายการของแอป

string

ป้ายกำกับที่จะแสดงสำหรับ PIN เช่น "PIN 4 หลัก"

string

ป้ายกํากับที่จะแสดงสําหรับหมายเลขเหตุการณ์ เช่น "เหตุการณ์เป้าหมาย #"

boolean

ระบุว่าผู้ขายรองรับการแลกบัตรของขวัญโดยใช้บาร์โค้ดหรือไม่ หากเป็น "จริง" แอปจะแสดงบาร์โค้ดของบัตรของขวัญบนหน้าจอรายละเอียดบัตรของขวัญ หากเป็นเท็จ บาร์โค้ดจะไม่แสดง

object (LocalizedString)

สตริงที่แปลแล้วสำหรับ merchantName แอปอาจแสดงเครื่องหมายจุดประยอยต่อจากอักขระ 20 ตัวแรกเพื่อให้แน่ใจว่าสตริงจะแสดงอย่างเต็มรูปแบบบนหน้าจอขนาดเล็ก

object (LocalizedString)

สตริงที่แปลแล้วสำหรับ pinLabel

object (LocalizedString)

สตริงที่แปลแล้วสําหรับ eventNumberLabel

string

ป้ายกำกับที่จะแสดงสำหรับหมายเลขบัตร เช่น "หมายเลขบัตร"

object (LocalizedString)

สตริงที่แปลแล้วสำหรับ cardNumberLabel

object (ClassTemplateInfo)

ข้อมูลเทมเพลตเกี่ยวกับวิธีแสดงชั้นเรียน หากไม่ได้ตั้งค่าไว้ Google จะแสดงชุดช่องเริ่มต้น

string

ต้องระบุ ตัวระบุที่ไม่ซ้ำกันสำหรับชั้นเรียน รหัสนี้ต้องไม่ซ้ำกันในทุกชั้นเรียนจากผู้ออกบัตร ค่านี้ควรเป็นไปตามรูปแบบ issuer IDidentifier โดยที่รหัสแรกจะออกโดย Google และรหัสหลังจะเลือกโดยคุณ ตัวระบุที่ไม่ซ้ำกันควรประกอบด้วยอักขระที่เป็นตัวอักษรและตัวเลขคละกัน, '.', '_' หรือ "-" เท่านั้น

string (int64 format)

เลิกใช้

string

ต้องระบุ ชื่อผู้ออกบัตร ความยาวสูงสุดที่แนะนำคือ 20 อักขระเพื่อให้สตริงแสดงเต็มรูปแบบบนหน้าจอขนาดเล็ก

object (Message)

อาร์เรย์ข้อความที่แสดงในแอป ผู้ใช้ทั้งหมดของออบเจ็กต์นี้จะได้รับข้อความที่เกี่ยวข้อง จํานวนสูงสุดของช่องเหล่านี้คือ 10 ช่อง

boolean

เลิกใช้งานแล้ว โปรดใช้ multipleDevicesAndHoldersAllowedStatus แทน

object (Uri)

URI ของหน้าแรกของแอปพลิเคชัน การใส่ URI ในช่องนี้ทำให้ได้ลักษณะการทำงานเหมือนกับการใส่ URI ใน linksModuleData (เมื่อแสดงผลออบเจ็กต์ ลิงก์ไปยังหน้าแรกจะแสดงในสิ่งที่มักมองว่าเป็นส่วนลิงก์ModuleData ของออบเจ็กต์)

object (LatLongPoint)

หมายเหตุ: ปัจจุบันระบบยังไม่รองรับการใช้ช่องนี้เพื่อทริกเกอร์การแจ้งเตือนทางภูมิศาสตร์

enum (ReviewStatus)

ต้องระบุ สถานะของชั้นเรียน ช่องนี้สามารถตั้งค่าเป็น draft หรือ underReview โดยใช้การแทรก แพตช์ หรืออัปเดตการเรียก API เมื่อสถานะการตรวจสอบเปลี่ยนจาก draft แล้ว คุณจะเปลี่ยนกลับไปเป็น draft ไม่ได้

คุณควรตั้งค่าช่องนี้เป็น draft เมื่อชั้นเรียนอยู่ระหว่างการพัฒนา คุณไม่สามารถใช้คลาส draft เพื่อสร้างออบเจ็กต์ใดๆ

คุณควรตั้งค่าช่องนี้เป็น underReview เมื่อเชื่อว่าชั้นเรียนพร้อมใช้งาน แพลตฟอร์มจะตั้งค่าช่องนี้เป็น approved โดยอัตโนมัติ และสามารถใช้เพื่อสร้างหรือย้ายข้อมูลออบเจ็กต์ได้ทันที

เมื่ออัปเดตชั้นเรียน approved ที่มีอยู่แล้ว คุณควรตั้งค่าช่องนี้เป็น underReview ต่อไป

object (Review)

ความคิดเห็นรีวิวที่แพลตฟอร์มตั้งค่าไว้เมื่อมีการทําเครื่องหมายชั้นเรียนเป็น approved หรือ rejected

object (InfoModuleData)

เลิกใช้งานแล้ว ให้ใช้ textModulesData แทน

object (ImageModuleData)

ข้อมูลโมดูลรูปภาพ จำนวนสูงสุดของช่องเหล่านี้ที่แสดงคือ 1 จากระดับออบเจ็กต์และ 1 สำหรับระดับออบเจ็กต์คลาส

object (TextModuleData)

ข้อมูลโมดูลข้อความ หากมีการกําหนดข้อมูลโมดูลข้อความในคลาสด้วย ระบบจะแสดงทั้ง 2 รายการ จำนวนสูงสุดของช่องเหล่านี้ที่แสดงคือ 10 ช่องจากออบเจ็กต์และ 10 ช่องจากคลาส

object (LinksModuleData)

ข้อมูลโมดูลลิงก์ หากมีการกําหนดข้อมูลโมดูลลิงก์ในออบเจ็กต์ด้วย ระบบจะแสดงทั้ง 2 รายการ

string (int64 format)

ระบุว่าผู้ออกการแลกสิทธิ์รายใดแลกรับบัตรผ่านการแตะอัจฉริยะได้ ระบบจะระบุผู้ออกบัตรแลกสิทธิ์ด้วยรหัสผู้ออกบัตร ผู้ออกบัตรแลกสิทธิ์ต้องกำหนดค่าคีย์ Smart Tap อย่างน้อย 1 รายการ

นอกจากนี้ คุณต้องตั้งค่าช่อง enableSmartTap และsmartTapRedemptionLevel ระดับออบเจ็กต์อย่างถูกต้องเพื่อให้บัตรรองรับการแตะอัจฉริยะ

string

รหัสประเทศที่ใช้แสดงประเทศของการ์ด (เมื่อผู้ใช้ไม่ได้อยู่ในประเทศนั้น) รวมถึงแสดงเนื้อหาที่แปลแล้วเมื่อเนื้อหาไม่พร้อมใช้งานในภาษาของผู้ใช้

object (Image)

รูปภาพแบนเนอร์ (ไม่บังคับ) ที่แสดงที่ด้านหน้าของการ์ด หากไม่มี ก็จะไม่แสดงผลใดๆ รูปภาพจะแสดงที่ความกว้าง 100%

object (Image)

เลิกใช้งานแล้ว

boolean

ระบุว่าคลาสนี้รองรับการแตะอัจฉริยะหรือไม่ ต้องตั้งค่าช่อง redemptionIssuers และระดับวัตถุ smartTapRedemptionLevel ให้ถูกต้องเพื่อให้บัตรรองรับการแตะอัจฉริยะ

string

สีพื้นหลังของการ์ด หากไม่ได้ตั้งค่า ระบบจะใช้สีหลักของรูปภาพหลัก และหากไม่ได้ตั้งค่ารูปภาพหลัก ระบบจะใช้สีหลักของโลโก้ รูปแบบคือ #rrggbb โดยที่ rrggbb เป็น 3 ทางคือ RGB แบบเลขฐานสิบหก เช่น #ffcc00 นอกจากนี้ คุณยังสามารถใช้ 3 เวอร์ชัน RGB แบบสั้นซึ่งเป็น #rgb เช่น #fc0

object (LocalizedString)

สตริงที่แปลแล้วสำหรับ issuerName ความยาวสูงสุดที่แนะนำคือ 20 อักขระเพื่อให้สตริงแสดงเต็มรูปแบบบนหน้าจอขนาดเล็ก

enum (MultipleDevicesAndHoldersAllowedStatus)

ระบุว่าผู้ใช้และอุปกรณ์หลายรายจะบันทึกออบเจ็กต์เดียวกันซึ่งอ้างอิงคลาสนี้หรือไม่

object (CallbackOptions)

ตัวเลือก Callback ที่จะใช้เพื่อเรียกผู้ออกบัตรกลับมาทุกครั้งที่ผู้ใช้ปลายทางทำการบันทึก/ลบออบเจ็กต์สำหรับคลาสนี้ ออบเจ็กต์ทั้งหมดของคลาสนี้มีสิทธิ์สำหรับ Callback

object (SecurityAnimation)

ข้อมูลเกี่ยวกับภาพเคลื่อนไหวเกี่ยวกับความปลอดภัย (ไม่บังคับ) หากตั้งค่านี้ ระบบจะแสดงภาพเคลื่อนไหวความปลอดภัยในรายละเอียดบัตร

enum (ViewUnlockRequirement)

ดูตัวเลือกข้อกำหนดการปลดล็อกสำหรับบัตรของขวัญ

object (Image)

โลโก้ขนาดกว้างของโปรแกรมหรือบริษัทบัตรของขวัญ หากระบุไว้ ระบบจะใช้รูปภาพนี้แทนโลโก้โปรแกรมที่ด้านซ้ายบนของมุมมองการ์ด

enum (NotificationSettingsForUpdates)

การตั้งค่าว่าควรมีการแจ้งเตือนเมื่อมีการอัปเดตช่องในชั้นเรียนนี้หรือไม่ เมื่อตั้งค่าเป็น "ไม่" เราจะพยายามส่งการแจ้งเตือนการอัปเดตช่องไปยังผู้ใช้ ระบบจะส่งการแจ้งเตือนเหล่านี้ไปยังผู้ใช้ก็ต่อเมื่อช่องเป็นส่วนหนึ่งของรายการที่อนุญาตเท่านั้น หากไม่ระบุ ระบบจะไม่ทริกเกอร์การแจ้งเตือน การตั้งค่านี้มีอายุไม่นานและจะต้องตั้งค่าพร้อมกับคำขอ PATCH หรือ UPDATE แต่ละรายการ มิฉะนั้นการแจ้งเตือนจะไม่ทริกเกอร์

object (AppLinkData)

ลิงก์แอปหรือเว็บไซต์ที่ไม่บังคับซึ่งจะแสดงเป็นปุ่มด้านหน้าบัตร หากระบุ AppLinkData สําหรับออบเจ็กต์ที่เกี่ยวข้อง ระบบจะใช้ AppLinkData นั้นแทน

object (ValueAddedModuleData)

ข้อมูลข้อบังคับมูลค่าเพิ่ม (ไม่บังคับ) นักเรียนสูงสุด 10 คนต่อชั้นเรียน สำหรับบัตร ระบบจะแสดงเพียง 10 รายการ โดยให้ความสำคัญกับบัตรจากวัตถุ