- משאב: LoyaltyObject
- LoyaltyPoints (נקודות מועדון לקוחות)
- LoyaltyPointsBalance
- שיטות
משאב: LoyaltyObject
ייצוג JSON |
---|
{ "kind": string, "classReference": { object ( |
שדות | |
---|---|
kind |
מזהה את סוג המשאב הזה. ערך: המחרוזת הקבועה |
classReference |
עותק של השדות שעברו בירושה של מחלקת ההורה. השדות האלה מאוחזרים במהלך GET. |
accountName |
שם הבעלים של חשבון מועדון הלקוחות, למשל "ישראל ישראלי". האורך המקסימלי המומלץ הוא 20 תווים, כדי להבטיח שהמחרוזת המלאה תוצג במסכים קטנים יותר. |
accountId |
המזהה של חשבון מועדון הלקוחות. האורך המקסימלי המומלץ הוא 20 תווים. |
loyaltyPoints |
התווית, היתרה והסוג של נקודות המועדון. |
linkedOfferIds[] |
רשימת אובייקטים של מבצע שמקושרים לכרטיס מועדון הלקוחות הזה. האובייקטים של המבצע חייבים להיות כבר קיימים. מזהי אובייקטים של מבצעים צריכים להיות בפורמט issuer ID.identifier שבו הראשון הונפק על ידי Google והאחרון נבחר על ידך. |
secondaryLoyaltyPoints |
התווית המשנית של נקודות המועדון, והסוג והיתרה. מוצגת בנוסף לנקודות המועדון הראשיות. |
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 וצילומי מסך. |
LoyaltyPoints
ייצוג JSON |
---|
{ "label": string, "balance": { object ( |
שדות | |
---|---|
label |
התווית של נקודות המועדון, למשל 'נקודות'. האורך המקסימלי המומלץ הוא 9 תווים. |
balance |
יתרת נקודות המועדון של בעל החשבון, למשל '500' או '10.00$'. האורך המקסימלי המומלץ הוא 7 תווים. זהו שדה חובה של |
localizedLabel |
מחרוזות מתורגמות עבור התווית. האורך המקסימלי המומלץ הוא 9 תווים. |
LoyaltyPointsBalance
ייצוג JSON |
---|
{
"string": string,
"int": integer,
"double": number,
"money": {
object ( |
שדות | |
---|---|
string |
צורת המחרוזת של יתרה. צריך לאכלס רק אחד מסוגי המשנה האלה (מחרוזת, int, כפול, כסף). |
int |
מספר שלם בצורת יתרה. צריך לאכלס רק אחד מסוגי המשנה האלה (מחרוזת, int, כפול, כסף). |
double |
צורה כפולה של יתרה. צריך לאכלס רק אחד מסוגי המשנה האלה (מחרוזת, int, כפול, כסף). |
money |
צורת הכסף של יתרה. צריך לאכלס רק אחד מסוגי המשנה האלה (מחרוזת, int, כפול, כסף). |
שיטות |
|
---|---|
|
הוספת הודעה לאובייקט הנאמנות שמזהה האובייקט הנתון מפנה אליו. |
|
מחזירה את אובייקט הנאמנות עם מזהה האובייקט הנתון. |
|
הוספת אובייקט נאמנות עם המזהה והמאפיינים הנתונים. |
|
מחזירה רשימה של כל האובייקטים של הנאמנות עבור מזהה מנפיק נתון. |
|
משנה את האובייקטים של המבצע המקושר של אובייקט הנאמנות עם המזהה הנתון. |
|
עדכון אובייקט הנאמנות שמזהה האובייקט הנתון מפנה אליו. |
|
עדכון אובייקט הנאמנות שמזהה האובייקט הנתון מפנה אליו. |