משאב: DocumentCardObject
ייצוג JSON |
---|
{ "kind": string, "classReference": { object ( |
שדות | |
---|---|
kind |
מזהה את סוג המשאב הזה. ערך: המחרוזת הקבועה |
classReference |
עותק של השדות שעברו בירושה של מחלקת ההורה. השדות האלה מאוחזרים במהלך GET. |
cardNumber |
חובה. מספר הכרטיס. |
pin |
קוד האימות של הכרטיס. |
balance |
היתרה הכספית של הכרטיס. |
balanceUpdateTime |
התאריך והשעה שבהם היתרה עודכנה לאחרונה. חובה לציין קיזוז. אם היתרה תתעדכן והנכס הזה לא סופק, המערכת תשתמש כברירת מחדל לפי השעה הנוכחית. |
eventNumber |
מספר האירוע של הכרטיס, שדה אופציונלי לשימוש בכרטיסי מתנה מסוימים. |
id |
חובה. המזהה הייחודי של אובייקט. המזהה הזה חייב להיות ייחודי בכל האובייקטים של המנפיק. הערך הזה צריך להיות בפורמט issuer ID.identifier שבו הראשון הונפק על ידי Google והאחרון נבחר על ידך. המזהה הייחודי יכול לכלול רק תווים אלפאנומריים, '.', '_' או '-'. |
classId |
חובה. המחלקה שמשויכת לאובייקט הזה. המחלקה חייבת להיות מאותו סוג כמו האובייקט הזה, היא חייבת להיות כבר קיימת וחייבת להיות מאושרת. מזהי מחלקות צריכים להיות בפורמט issuer ID.identifier שבו הראשון הונפק על ידי Google והאחרון נבחר על ידך. |
version |
הוצא משימוש |
state |
חובה. מצב האובייקט. השדה הזה משמש לקביעת אופן ההצגה של אובייקט באפליקציה. לדוגמה, אובייקט |
barcode |
הסוג והערך של הברקוד. |
messages[] |
מערך הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות המשויכות אליו. המספר המקסימלי של השדות האלה הוא 10. |
validTimeInterval |
פרק הזמן שבו האובייקט הזה יהיה |
locations[] |
הערה: בשלב זה השדה הזה לא נתמך להפעלת התראות גיאוגרפיות. |
hasUsers |
מציין אם לאובייקט יש משתמשים. השדה הזה מוגדר על ידי הפלטפורמה. |
smartTapRedemptionValue |
הערך שיועבר למסוף מאושר בהקשה חכמה ב-NFC עבור האובייקט הזה. גם השדות ברמת הכיתה |
hasLinkedDevice |
אם האובייקט הזה מקושר כרגע למכשיר אחד. השדה הזה מוגדר על ידי הפלטפורמה כשמשתמש שומר את האובייקט ומקשר אותו למכשיר שלו. מיועד לשימוש על ידי שותפים נבחרים. לקבלת מידע נוסף, אפשר לפנות לתמיכה. |
disableExpirationNotification |
שדה זה מציין אם יש להסתיר את ההתראות באופן מפורש. אם השדה הזה מוגדר כ-True, לא משנה מה השדה כרגע אפשר להגדיר את האפשרות הזו רק למבצעים. |
infoModuleData |
הוּצא משימוש. במקומו צריך להשתמש ב-textModulesData. |
imageModulesData[] |
נתונים של מודול התמונה. המספר המקסימלי של השדות המוצגים הוא 1 ברמת האובייקט ו-1 ברמת האובייקט של הכיתה. |
textModulesData[] |
נתונים של מודול טקסט. אם נתונים של מודול טקסט מוגדרים גם במחלקה, שניהם יוצגו. המספר המקסימלי של השדות המוצגים הוא 10 מהאובייקט ו-10 מהמחלקה. |
linksModuleData |
נתונים של מודול הקישורים. אם נתוני מודול הקישורים מוגדרים גם במחלקה, שניהם יוצגו. |
appLinkData |
קישור אופציונלי לאפליקציה או לאתר שיוצג כלחצן בתחילת הכרטיס. אם הוגדר AppLinkData עבור המחלקה המתאימה, יוצג רק האובייקט AppLinkData. |
rotatingBarcode |
הסוג והערך של הברקוד המסתובב. |
heroImage |
תמונת באנר אופציונלית מוצגת בחזית הכרטיס. אם אין תעודה מזהה, תוצג התמונה הראשית של הכיתה (אם יש כזו). אם גם התמונה הראשית (Hero) של הכיתה לא מוצגת, שום דבר לא יוצג. |
groupingInfo |
מידע שקובע איך הכרטיסים יקובצו יחד. |
passConstraints |
מעבירים את האילוצים של האובייקט. כולל הגבלת התנהגויות של NFC וצילומי מסך. |
שיטות |
|
---|---|
|
הוספת הודעה לאובייקט של כרטיס המתנה שיש אליו הפניה ממזהה האובייקט הנתון. |
|
מחזירה את האובייקט של כרטיס המתנה עם מזהה האובייקט הנתון. |
|
הוספת אובייקט של כרטיס מתנה עם המזהה והמאפיינים הנתונים. |
|
מחזירה רשימה של כל האובייקטים של כרטיס המתנה עבור מזהה מנפיק נתון. |
|
עדכון האובייקט של כרטיס המתנה שמזהה האובייקט הנתון מפנה אליו. |
|
עדכון האובייקט של כרטיס המתנה שמזהה האובייקט הנתון מפנה אליו. |