REST Resource: genericclass

ทรัพยากร: genericClass

ชั้นเรียนทั่วไป

การแสดง JSON
{
  "id": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "enableSmartTap": boolean,
  "redemptionIssuers": [
    string
  ],
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "messages": [
    {
      object (Message)
    }
  ],
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
ช่อง
id

string

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

classTemplateInfo

object (ClassTemplateInfo)

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

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

enableSmartTap

boolean

พร้อมให้บริการแก่พาร์ทเนอร์ที่เปิดใช้การแตะอัจฉริยะเท่านั้น โปรดติดต่อทีมสนับสนุนเพื่อขอคำแนะนำเพิ่มเติม

redemptionIssuers[]

string (int64 format)

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

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

securityAnimation

object (SecurityAnimation)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

viewUnlockRequirement

enum (ViewUnlockRequirement)

ดูตัวเลือกข้อกำหนดในการปลดล็อกสำหรับบัตรทั่วไป

messages[]

object (Message)

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

valueAddedModuleData[]

object (ValueAddedModuleData)

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

เมธอด

addmessage

เพิ่มข้อความลงในคลาสทั่วไปที่อ้างอิงโดยรหัสคลาสที่ระบุ

get

แสดงผลคลาสทั่วไปที่มีรหัสคลาสที่ระบุ

insert

แทรกคลาสทั่วไปที่มีรหัสและพร็อพเพอร์ตี้ที่กำหนด

list

แสดงผลรายการคลาสทั่วไปทั้งหมดสำหรับรหัสผู้ออกบัตรที่ระบุ

patch

อัปเดตคลาสทั่วไปที่อ้างอิงโดยรหัสชั้นเรียนที่ระบุ

update

อัปเดตคลาสทั่วไปที่อ้างอิงโดยรหัสคลาสที่ระบุ