משאב: LoyaltyClass
ייצוג ב-JSON |
---|
{ "kind": string, "programName": string, "programLogo": { object ( |
שדות | |
---|---|
kind |
מזהה את סוג המשאב. ערך: המחרוזת הקבועה |
programName |
חובה. שם התוכנית, למשל 'Adam's Apparel'. יכול להיות שבאפליקציה יוצג קו נטוי (ellipsis) אחרי 20 התווים הראשונים, כדי להבטיח שהמחרוזת המלאה תוצג במסכים קטנים יותר. |
programLogo |
חובה. הלוגו של מועדון הלקוחות או החברה. הלוגו הזה מוצג גם בתצוגת הפרטים וגם בתצוגת הרשימה של האפליקציה. |
accountNameLabel |
תווית שם החשבון, למשל 'שם החבר'. האורך המקסימלי המומלץ הוא 15 תווים, כדי להבטיח שהמחרוזת תוצג במלואה במסכים קטנים יותר. |
accountIdLabel |
תווית מזהה החשבון, למשל 'מזהה חבר'. האורך המקסימלי המומלץ הוא 15 תווים, כדי להבטיח שהמחרוזת תוצג במלואה במסכים קטנים יותר. |
rewardsTierLabel |
התווית של רמת ההטבות, למשל 'רמת ההטבות'. האורך המקסימלי המומלץ הוא 9 תווים, כדי לוודא שהמחרוזת תוצג במלואה במסכים קטנים יותר. |
rewardsTier |
רמת התגמולים, למשל 'זהב' או 'פלטינה'. האורך המקסימלי המומלץ הוא 7 תווים, כדי שהמחרוזת השלמה תוצג במסכים קטנים יותר. |
localizedProgramName |
מחרוזות מתורגמות של programName. יכול להיות שבאפליקציה יוצג קו נטוי (ellipsis) אחרי 20 התווים הראשונים, כדי להבטיח שהמחרוזת המלאה תוצג במסכים קטנים יותר. |
localizedAccountNameLabel |
מחרוזות מתורגמות של accountNameLabel. האורך המקסימלי המומלץ הוא 15 תווים, כדי להבטיח שהמחרוזת תוצג במלואה במסכים קטנים יותר. |
localizedAccountIdLabel |
מחרוזות מתורגמות של accountIdLabel. האורך המקסימלי המומלץ הוא 15 תווים, כדי להבטיח שהמחרוזת תוצג במלואה במסכים קטנים יותר. |
localizedRewardsTierLabel |
מחרוזות מתורגמות של rewardsTierLabel. האורך המקסימלי המומלץ הוא 9 תווים, כדי לוודא שהמחרוזת תוצג במלואה במסכים קטנים יותר. |
localizedRewardsTier |
מחרוזות מתורגמות של rewardsTier. האורך המקסימלי המומלץ הוא 7 תווים, כדי שהמחרוזת תופיע במלואה במסכים קטנים יותר. |
secondaryRewardsTierLabel |
התווית של רמת ההטבות המשנית, למשל 'רמת הטבות'. |
localizedSecondaryRewardsTierLabel |
מחרוזות מתורגמות של secondaryRewardsTierLabel. |
secondaryRewardsTier |
דרגת ההטבות המשנית, למשל 'זהב' או 'פלטינה'. |
localizedSecondaryRewardsTier |
מחרוזות מתורגמות של secondaryRewardsTier. |
discoverableProgram |
מידע על האופן שבו אפשר לגלות את הכיתה וליצור אותה מתוך אפליקציית Google Pay. |
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[] |
נתונים אופציונליים של מודול עם ערך מוסף. עד עשרה תלמידים בכיתה. לגבי כרטיס, יוצגו רק עשרה, והעדיפות תהיה לנתונים מהעצם. |
DiscoverableProgram
מידע על האופן שבו אפשר לגלות כיתה וליצור אותה מתוך אפליקציית Android Pay. לשם כך, מחפשים תוכנית של כרטיס מועדון לקוחות או כרטיס מתנה ומסרקים או מזינים אותה באופן ידני.
ייצוג ב-JSON |
---|
{ "merchantSignupInfo": { object ( |
שדות | |
---|---|
merchantSignupInfo |
מידע על האפשרות להירשם לתוכנית הזו ולהוסיף לה נכס דיגיטלי שאפשר לממש דרך אתר של מוכר. משמש כשהאפשרות MERCHANT_HOSTED_SIGNUP מופעלת. |
merchantSigninInfo |
מידע על היכולת להיכנס לחשבון ולהוסיף פריט בעל ערך לתוכנית הזו דרך אתר של מוכר. משמש כשהאפשרות MERCHANT_HOSTED_SIGNIN מופעלת. |
state |
מצב החשיפה של התוכנית שגלויה לכולם. |
DiscoverableProgramMerchantSignupInfo
מידע על תהליך ההרשמה לתוכנית שמתארח באתר של המוכר.
ייצוג ב-JSON |
---|
{ "signupWebsite": { object ( |
שדות | |
---|---|
signupWebsite |
כתובת ה-URL שאליה המשתמש יועבר לאתר ההרשמה של המוכר. |
signupSharedDatas[] |
נתוני משתמשים שנשלחים בבקשת POST לכתובת ה-URL של אתר ההרשמה. המידע הזה מקודד ולאחר מכן משותף, כדי שאתר המוכר יוכל למלא מראש שדות שמשמשים להרשמה של המשתמש לתוכנית הגלויה. |
DiscoverableProgramMerchantSigninInfo
מידע על תהליך הכניסה לאתר של מועדון לקוחות שמתארח אצל המוכר.
ייצוג ב-JSON |
---|
{
"signinWebsite": {
object ( |
שדות | |
---|---|
signinWebsite |
כתובת ה-URL שאליה המשתמש יועבר לאתר הכניסה של המוכר. |
מדינה
טיפוסים בני מנייה (enum) | |
---|---|
STATE_UNSPECIFIED |
|
TRUSTED_TESTERS |
מוצג רק לבודקים שיש להם גישה לחשבון המנפיק. |
trustedTesters |
כתובת אימייל חלופית מדור קודם של |
LIVE |
גלוי לכולם. |
live |
כתובת אימייל חלופית מדור קודם של |
DISABLED |
לא גלוי. |
disabled |
כתובת אימייל חלופית מדור קודם של |
Methods |
|
---|---|
|
הוספת הודעה לקבוצת הלקוחות הנאמנים שמשויכת למזהה הקבוצה הנתון. |
|
הפונקציה מחזירה את רמת הלקוח במועדון הלקוחות לפי מזהה המחלקה שצוין. |
|
הוספה של סיווג לקוחות נאמנים עם המזהה והמאפיינים שצוינו. |
|
הפונקציה מחזירה רשימה של כל רמות החברות במועדון הלקוחות למזהה מנפיק נתון. |
|
הפונקציה מעדכנת את קטגוריית המועדון שללקוח שייך, לפי מזהה הקטגוריה שצוין. |
|
הפונקציה מעדכנת את קטגוריית המועדון שללקוח שייך, לפי מזהה הקטגוריה שצוין. |