משאב: GiftCardClass
ייצוג ב-JSON |
---|
{ "kind": string, "merchantName": string, "programLogo": { object ( |
שדות | |
---|---|
kind |
מזהה את סוג המשאב. ערך: המחרוזת הקבועה |
merchantName |
שם המוכר, למשל 'Adam's Apparel'. יכול להיות שבאפליקציה יוצג קו נטוי (ellipsis) אחרי 20 התווים הראשונים, כדי להבטיח שהמחרוזת המלאה תוצג במסכים קטנים יותר. |
programLogo |
הלוגו של החברה או של תוכנית כרטיס המתנה. הלוגו הזה מוצג גם בתצוגת הפרטים וגם בתצוגת הרשימה של האפליקציה. |
pinLabel |
התווית שמוצגת לקוד האימות, למשל 'קוד אימות בן 4 ספרות'. |
eventNumberLabel |
התווית שמוצגת עבור מספר האירוע, למשל 'אירוע יעד מס'. |
allowBarcodeRedemption |
המאפיין הזה קובע אם המוכר תומך במימוש כרטיס מתנה באמצעות קוד מ barras. אם הערך הוא True, האפליקציה תציג ברקוד של כרטיס המתנה במסך 'פרטי כרטיס המתנה'. אם הערך הוא false, הברקוד לא מוצג. |
localizedMerchantName |
מחרוזות מתורגמות של merchantName. יכול להיות שבאפליקציה יוצג קו נטוי (ellipsis) אחרי 20 התווים הראשונים, כדי להבטיח שהמחרוזת המלאה תוצג במסכים קטנים יותר. |
localizedPinLabel |
מחרוזות מתורגמות של pinLabel. |
localizedEventNumberLabel |
מחרוזות מתורגמות של eventNumberLabel. |
cardNumberLabel |
התווית שמוצגת לצד מספר הכרטיס, למשל 'מספר כרטיס'. |
localizedCardNumberLabel |
מחרוזות מתורגמות של cardNumberLabel. |
classTemplateInfo |
פרטי התבנית לגבי אופן הצגת הכיתה. אם לא תגדירו את השדה, Google תשתמש בקבוצת שדות ברירת מחדל להצגה. |
id |
חובה. המזהה הייחודי של הכיתה. המזהה הזה חייב להיות ייחודי בכל הכיתות של מנפיק. הערך צריך להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם. המזהה הייחודי צריך לכלול רק תווים אלפאנומריים, '.', '_' או '-'. |
version |
הוצא משימוש |
issuerName |
חובה. שם המנפיק. האורך המקסימלי המומלץ הוא 20 תווים, כדי שהמחרוזת תוצג במלואה במסכים קטנים יותר. |
messages[] |
מערך של הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות המשויכות אליו. המספר המקסימלי של השדות האלה הוא 10. |
allowMultipleUsersPerObject |
הוצא משימוש. במקום זאת, אתם צריכים להשתמש ב- |
homepageUri |
ה-URI של דף הבית של האפליקציה. האכלוס של ה-URI בשדה הזה גורם לאותו התנהגות בדיוק כמו האכלוס של ה-URI ב-linksModuleData (כשאובייקט מנוהל, קישור לדף הבית מוצג במקום שנחשב בדרך כלל לקטע linksModuleData של האובייקט). |
locations[] |
הערה: בשלב הזה אין תמיכה בשדה הזה כדי להפעיל התראות גיאוגרפיות. |
reviewStatus |
חובה. הסטטוס של הכיתה. אפשר להגדיר את השדה הזה לערך כשהשיעור נמצא בפיתוח, צריך להשאיר את השדה הזה עם הערך צריך להגדיר את השדה הזה ל- כשמעדכנים כיתה שכבר מוגדרת כ- |
review |
תגובות הבדיקה שמוגדרות על ידי הפלטפורמה כשכיתה מסומנת בסטטוס |
infoModuleData |
הוצא משימוש. במקום זאת, צריך להשתמש ב-textModulesData. |
imageModulesData[] |
נתוני מודול התמונה. המספר המקסימלי של השדות האלה שמוצגים הוא 1 ברמת האובייקט ו-1 ברמת אובייקט הכיתה. |
textModulesData[] |
נתונים של מודול טקסט. אם מוגדרים גם נתונים של מודול טקסט בכיתה, יוצגו שניהם. המספר המקסימלי של השדות האלה שמוצגים הוא 10 מהאובייקט ו-10 מהכיתה. |
linksModuleData |
נתוני המודול 'קישורים'. אם הנתונים של מודול הקישורים מוגדרים גם באובייקט, יוצגו שניהם. |
redemptionIssuers[] |
מזהה את מנפיקי השוברים שיכולים לממש את הכרטיס באמצעות Smart Tap. מנפיקי שוברי המימוש מזוהים לפי מזהה המנפיק שלהם. למנפיקים של שוברי מימוש צריך להיות מוגדר לפחות מפתח אחד של Smart Tap. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדות |
countryCode |
קוד המדינה שמשמש להצגת המדינה של הכרטיס (כשהמשתמש לא נמצא במדינה הזו), וגם להצגת תוכן מותאם כשהתוכן לא זמין באזור הגיאוגרפי של המשתמש. |
heroImage |
תמונה אופציונלית של באנר שמוצגת בחזית הכרטיס. אם לא תהיה כותרת, לא יוצג דבר. התמונה תוצג ב-100% רוחב. |
wordMark |
הוצא משימוש. |
enableSmartTap |
האפשרות הזו קובעת אם הכיתה תומכת בהקשה חכמה. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדות |
hexBackgroundColor |
צבע הרקע של הכרטיס. אם לא תגדירו צבע, המערכת תשתמש בצבע השולט בתמונה הראשית. אם לא תגדירו תמונה ראשית, המערכת תשתמש בצבע השולט בלוגו. הפורמט הוא #rrggbb, כאשר rrggbb הוא טריופל RGB ב-hex, למשל |
localizedIssuerName |
מחרוזות מתורגמות של השדה issuerName. האורך המקסימלי המומלץ הוא 20 תווים, כדי שהמחרוזת תופיע במלואה במסכים קטנים יותר. |
multipleDevicesAndHoldersAllowedStatus |
האפשרות הזו קובעת אם מספר משתמשים ומכשירים ישמרו את אותו אובייקט שמפנה לכיתה הזו. |
callbackOptions |
אפשרויות קריאה חוזרת (callback) שישמשו לקריאה חוזרת למנפיק בכל פעם שמשתמש הקצה שומר או מחק אובייקט מהסוג הזה. כל האובייקטים מהסוג הזה עומדים בדרישות להפעלת פונקציית ה-callback. |
securityAnimation |
מידע אופציונלי על אנימציית האבטחה. אם ההגדרה הזו מוגדרת, תופעל אנימציית אבטחה בפרטי הכרטיס. |
viewUnlockRequirement |
בודקים את האפשרויות של דרישת הנעילה של כרטיס המתנה. |
wideProgramLogo |
הלוגו הרחב של החברה או של תוכנית כרטיסי המתנה. אם תספקו לוגו, הוא ישמש במקום הלוגו של התוכנית בפינה הימנית העליונה של תצוגת הכרטיס. |
notifyPreference |
אם עדכוני שדות בכיתה הזו יפעילו התראות או לא. כשהערך מוגדר ל-NOTIFY, אנחנו מנסים להפעיל התראה למשתמשים על עדכון השדה. ההתראות האלה יישלחו למשתמשים רק אם השדה נכלל ברשימת ההיתרים. אם לא יצוין ערך, לא תופעל התראה. ההגדרה הזו היא זמנית וצריך להגדיר אותה בכל בקשת PATCH או UPDATE, אחרת לא תופעל התראה. |
appLinkData |
קישור אופציונלי לאפליקציה או לאתר שיוצג כלחצן בחזית הכרטיס. אם מציינים את AppLinkData לאובייקט המתאים, המערכת תשתמש בו במקום זאת. |
valueAddedModuleData[] |
נתונים אופציונליים של מודול עם ערך מוסף. עד עשרה תלמידים בכיתה. לגבי כרטיס, יוצגו רק עשרה, והעדיפות תהיה לנתונים מהעצם. |
Methods |
|
---|---|
|
הוספת הודעה לכיתה של כרטיס המתנה שמוזכר במזהה הכיתה הנתון. |
|
הפונקציה מחזירה את קטגוריית כרטיסי המתנה עם מזהה הכיתה הנתון. |
|
הוספה של מחלקת כרטיס מתנה עם המזהה והמאפיינים שצוינו. |
|
הפונקציה מחזירה רשימה של כל הכיתות של כרטיסי המתנה למזהה מנפיק נתון. |
|
הקוד מעדכן את קטגוריית כרטיסי המתנה שמשויכת למזהה הכיתה הנתון. |
|
הקוד מעדכן את קטגוריית כרטיסי המתנה שמשויכת למזהה הכיתה הנתון. |