משאב: GenericObject
אובייקט גנרי
ייצוג ב-JSON |
---|
{ "genericType": enum ( |
שדות | |
---|---|
genericType |
מציינים את |
cardTitle |
חובה. הכותרת של הכרטיס. בדרך כלל זהו שם העסק, למשל 'מכון כושר XXX', 'ביטוח AAA'. השדה הזה חובה והוא מופיע בשורת הכותרת בחלק העליון של הכרטיס. |
subheader |
תווית הכותרת של הכרטיס, למשל המיקום שבו אפשר להשתמש בכרטיס. מופיע ממש מעל השם בשורת הכותרת בתצוגת פרטי הכרטיס. |
header |
חובה. שם הכרטיס, למשל 'שובר הנחה של 50%', 'כרטיס ספרייה' או 'שובר'. השדה הזה הוא חובה והוא מופיע בשורת הכותרת בתצוגת הפרטים של הכרטיס. |
logo |
תמונת הלוגו של הכרטיס. התמונה הזו מוצגת בתצוגת הפרטים של הכרטיס בפינה הימנית העליונה, וגם בתצוגת הרשימה או התצוגה של התמונות הממוזערות. אם הלוגו לא יופיע, האות הראשונה של |
hexBackgroundColor |
צבע הרקע של הכרטיס. אם לא תגדירו צבע, המערכת תשתמש בצבע השולט בתמונה הראשית. אם לא תגדירו תמונה ראשית, המערכת תשתמש בצבע השולט בלוגו. אם לא תגדירו לוגו, Google תבחר צבע. |
notifications |
הגדרות ההתראות שמופעלות עבור האובייקט הזה. |
id |
חובה. המזהה הייחודי של אובייקט. המזהה הזה חייב להיות ייחודי בכל האובייקטים של מנפיק. הערך הזה צריך להיות בפורמט |
classId |
חובה. הכיתה שמשויכת לאובייקט הזה. הכיתה צריכה להיות מאותו סוג כמו האובייקט הזה, היא כבר צריכה להתקיים והיא צריכה להיות מאושרת. מזהי הכיתות צריכים להיות בפורמט |
barcode |
סוג הברקוד והערך שלו. אם לכרטיס אין ברקוד, אנחנו יכולים לאפשר למנפיק להגדיר את Barcode.alternate_text ולהציג רק אותו. |
heroImage |
תמונת הבאנר שמוצגת בחזית הכרטיס, אם יש כזו. התמונה תוצג ב-100% רוחב. |
validTimeInterval |
תקופת הזמן שבה האובייקט יהיה תקף או שאפשר יהיה להשתמש בו. כשתקופת הזמן תסתיים, האובייקט ייחשב בתוקף פג, והדבר ישפיע על העיבוד במכשירים של המשתמשים. |
imageModulesData[] |
נתוני מודול התמונה. אם מגדירים את שתי התמונות, רק אחת מהן תעבור עיבוד – התמונה ברמת הכיתה או התמונה ברמת האובייקט. |
textModulesData[] |
נתונים של מודול טקסט. אם גם |
linksModuleData |
נתוני המודול 'קישורים'. אם גם |
appLinkData |
קישור אופציונלי לאפליקציה או לאתר שיוצג כלחצן בחזית הכרטיס. אם יסופקו נתוני AppLinkData לסיווג המתאים, יוצגו רק נתוני AppLinkData של האובייקט. |
groupingInfo |
מידע שקובע את אופן הקיבוץ של הכרטיסים. |
smartTapRedemptionValue |
הערך שיישלח לאובייקט הזה למסוף מאושר של Smart Tap באמצעות NFC. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדות |
rotatingBarcode |
ההגדרות או הפרטים של הברקוד המסתובב. |
state |
המצב של האובייקט. השדה הזה משמש לקביעת האופן שבו אובייקט מוצג באפליקציה. לדוגמה, אובייקט |
hasUsers |
מציין אם יש לאובייקט משתמשים. השדה הזה מוגדר על ידי הפלטפורמה. |
messages[] |
מערך של הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות המשויכות אליו. המספר המקסימלי של השדות האלה הוא 10. |
passConstraints |
מעבירים את האילוצים של האובייקט. כולל הגבלת התנהגויות של NFC וצילומי מסך. |
wideLogo |
הלוגו הרחב של הכרטיס. אם תספקו תמונה, היא תוצג במקום הלוגו בפינה הימנית העליונה של תצוגת הכרטיס. |
saveRestrictions |
הגבלות על האובייקט שצריך לאמת לפני שהמשתמש ינסה לשמור את הכרטיס. חשוב לזכור שההגבלות האלה יחולו רק במהלך זמן השמירה. אם ההגבלות השתנו אחרי שהמשתמש שמר את הכרטיס, ההגבלות החדשות לא יחולו על כרטיס שכבר נשמר. |
valueAddedModuleData[] |
נתונים אופציונליים של מודול עם ערך מוסף. עד עשר באותו אובייקט. |
linkedObjectIds[] |
linkedObjectIds היא רשימה של אובייקטים אחרים, כמו כרטיס אירוע, כרטיס מועדון לקוחות, מבצע, אובייקט כללי, כרטיס מתנה, כרטיס לתחבורה ציבורית וכרטיס עלייה למטוס, שצריך לצרף באופן אוטומטי לאובייקט הכללי הזה. אם משתמש שמר את הכרטיס הגנרי הזה, מזהי ה-linkedObjectIds האלה יועברו באופן אוטומטי לארנק של המשתמש (אלא אם הוא השבית את ההגדרה לקבלת כרטיסים מקושרים כאלה). חשוב לוודא שהאובייקטים שמופיעים ב-linkedObjectIds כבר הוכנסו – אחרת הקריאות ייכשל. אחרי שמקשרים אובייקטים, אי אפשר לבטל את הקישור שלהם. אי אפשר לקשר אובייקטים ששייכים למנפיק אחר. יש מגבלה על מספר האובייקטים שאפשר לקשר לאובייקט יחיד. אחרי שמגיעים למגבלה, המערכת תתעלם בשקט מאובייקטים מקושרים חדשים בשיחה. מזהי אובייקטים צריכים להיות בפורמט issuer ID.identifier, כאשר הראשון מונפק על ידי Google והשני נבחר על ידכם. |
GenericType
סוג הכרטיס הכללי.
טיפוסים בני מנייה (enum) | |
---|---|
GENERIC_TYPE_UNSPECIFIED |
סוג כללי לא צוין. |
GENERIC_SEASON_PASS |
כרטיס עונתי |
GENERIC_UTILITY_BILLS |
חשבונות על תשתיות |
GENERIC_PARKING_PASS |
כרטיס חניה |
GENERIC_VOUCHER |
שובר |
GENERIC_GYM_MEMBERSHIP |
כרטיסי מינוי למכון כושר |
GENERIC_LIBRARY_MEMBERSHIP |
כרטיסי חברות בספרייה |
GENERIC_RESERVATIONS |
הזמנות |
GENERIC_AUTO_INSURANCE |
כרטיסי ביטוח רכב |
GENERIC_HOME_INSURANCE |
כרטיסי ביטוח לבית |
GENERIC_ENTRY_TICKET |
כרטיסי כניסה |
GENERIC_RECEIPT |
קבלות |
GENERIC_LOYALTY_CARD |
כרטיסי מועדון לקוחות. לתשומת ליבכם: מומלץ להשתמש בסוג כרטיס ייעודי של כרטיס נאמנות במקום בסוג הזה שהוא כללי. כרטיס מועדון לקוחות ייעודי מציע יותר תכונות ופונקציות מאשר כרטיס גנרי. |
GENERIC_OTHER |
סוג אחר |
התראות
מציין אם צריך להפעיל התראות לגבי האובייקט. אנחנו תומכים רק באחד מהאירועים ExpiryNotification/UpcomingNotification. expiryNotification
מקבלת עדיפות על פני upcomingNotification
. במילים אחרות, אם השדה expiryNotification
מוגדר, המערכת מתעלמת מהשדה upcomingNotification
.
ייצוג ב-JSON |
---|
{ "expiryNotification": { object ( |
שדות | |
---|---|
expiryNotification |
תישלח התראה במועד ספציפי לפני שתוקף הכרטיס יפוג. |
upcomingNotification |
תישלח התראה במועד ספציפי לפני שאפשר יהיה להשתמש בכרטיס. |
ExpiryNotification
המשמעות היא שהמנפיק רוצה ש-Google Wallet תשלח התראות על תפוגת התוקף יומיים לפני תאריך התפוגה של הכרטיס.
ייצוג ב-JSON |
---|
{ "enableNotification": boolean } |
שדות | |
---|---|
enableNotification |
הערך הזה מציין אם צריך להפעיל התראה על תפוגה של האובייקט. |
UpcomingNotification
המשמעות של הסטטוס הזה היא שהמנפיק רוצה שמערכת Google Wallet תשלח התראה על תוקף הכרטיס הקרוב יום אחד לפני שהכרטיס יהפוך לתקף או לזמין לשימוש.
ייצוג ב-JSON |
---|
{ "enableNotification": boolean } |
שדות | |
---|---|
enableNotification |
מציין אם צריך להפעיל התראה על אירוע שעומד להתרחש באובייקט. |
Methods |
|
---|---|
|
הוספת הודעה לאובייקט הגנרי שמוזכר במזהה האובייקט הנתון. |
|
הפונקציה מחזירה את האובייקט הגנרי עם מזהה האובייקט שצוין. |
|
הוספה של אובייקט כללי עם המזהה והמאפיינים שצוינו. |
|
הפונקציה מחזירה רשימה של כל האובייקטים הכלליים למזהה מנפיק נתון. |
|
עדכון האובייקט הגנרי שמשויך למזהה האובייקט הנתון. |
|
עדכון האובייקט הגנרי שמשויך למזהה האובייקט הנתון. |