REST Resource: genericclass

משאב: GenericClass

Generic Class

ייצוג ב-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 מוגדר באובייקט, יוצגו שניהם. אם מגדירים את שתי התמונות, רק אחת מהן תעבור עיבוד – התמונה ברמת הכיתה או התמונה ברמת האובייקט.
textModulesData[]

object (TextModuleData)

נתונים של מודול טקסט. אם גם textModulesData מוגדר באובייקט, שניהם יוצגו. המספר המקסימלי של השדות האלה שמוצגים הוא 10 מהקלאס ו-10 מהאובייקט.
enableSmartTap

boolean

האפשרות הזו זמינה רק לשותפים שהפעילו את התכונה 'לחיצה חכמה'. לקבלת הנחיות נוספות, אפשר לפנות לתמיכה.
redemptionIssuers[]

string (int64 format)

מזהה את מנפיקי השוברים שיכולים לממש את הכרטיס באמצעות Smart Tap. מנפיקי שוברי המימוש מזוהים לפי מזהה המנפיק שלהם. למנפיקים של שוברי מימוש צריך להיות מוגדר לפחות מפתח אחד של Smart Tap.

כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדות enableSmartTap ו-smartTapRedemptionLevel ברמת האובייקט.
securityAnimation

object (SecurityAnimation)

מידע אופציונלי על אנימציית האבטחה. אם ההגדרה הזו מוגדרת, תופעל אנימציית אבטחה בפרטי הכרטיס.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

האפשרות הזו קובעת אם מספר משתמשים ומכשירים ישמרו את אותו אובייקט שמפנה לכיתה הזו.
callbackOptions

object (CallbackOptions)

אפשרויות קריאה חוזרת (callback) שישמשו לקריאה חוזרת למנפיק בכל פעם שמשתמש הקצה שומר או מחק אובייקט מהסוג הזה. כל האובייקטים מהסוג הזה עומדים בדרישות להפעלת פונקציית ה-callback.
viewUnlockRequirement

enum (ViewUnlockRequirement)

בודקים את האפשרויות של דרישת הנעילה לכרטיס הגנרי.
messages[]

object (Message)

מערך של הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות המשויכות אליו. המספר המקסימלי של השדות האלה הוא 10.
valueAddedModuleData[]

object (ValueAddedModuleData)

נתונים אופציונליים של מודול עם ערך מוסף. עד עשרה תלמידים בכיתה. לגבי כרטיס, יוצגו רק עשרה, והעדיפות תהיה לנתונים מהעצם.

Methods

addmessage

 הוספת הודעה לכיתה הגנרית שמופיעה במזהה הכיתה הנתון.

get

 הפונקציה מחזירה את המחלקה הגנרית עם מזהה המחלקה שצוין.

insert

 הוספה של מחלקה גנרית עם המזהה והמאפיינים שצוינו.

list

 הפונקציה מחזירה רשימה של כל הכיתות הכלליות למזהה מנפיק נתון.

patch

 הקוד מעדכן את הכיתה הגנרית שמופיעה במזהה הכיתה הנתון.

update

 הקוד מעדכן את הכיתה הגנרית שמוזכר בה מזהה הכיתה הנתון.