משאב: GiftCardObject
ייצוג JSON |
---|
{ "kind": string, "classReference": { object ( |
שדות | |
---|---|
kind |
מזהה את סוג המשאב. ערך: המחרוזת הקבועה |
class |
עותק של השדות שעברו בירושה מכיתה ההורה. השדות האלה מאוחזרים במהלך קריאה מסוג GET. |
card |
חובה. מספר הכרטיס. |
pin |
קוד האימות של הכרטיס. |
balance |
היתרה הכספית בכרטיס. |
balance |
התאריך והשעה שבהם היתרה עודכנה לאחרונה. חובה לציין את הזזת האופרטור. אם היתרה מתעדכנת והמאפיין הזה לא מסופק, המערכת תשתמש בשעון הנוכחי כברירת מחדל. |
event |
מספר האירוע של הכרטיס. זהו שדה אופציונלי שמשמש בכרטיסי מתנה מסוימים. |
id |
חובה. המזהה הייחודי של אובייקט. המזהה הזה חייב להיות ייחודי בכל האובייקטים של המנפיק. הערך צריך להיות בפורמט issuer ID.identifier כאשר הראשון הונפק על ידי Google והאחרון נבחר על ידך. המזהה הייחודי צריך לכלול רק תווים אלפאנומריים, '.', '_' או '-'. |
class |
חובה. המחלקה שמשויכת לאובייקט הזה. הכיתה צריכה להיות מאותו סוג כמו האובייקט הזה, היא כבר צריכה להתקיים והיא צריכה להיות מאושרת. מזהי הכיתות צריכים להיות בפורמט issuer ID.identifier כאשר הראשון הונפק על ידי Google והאחרון נבחר על ידך. |
version |
הוצא משימוש |
state |
חובה. המצב של האובייקט. השדה הזה משמש לקביעת האופן שבו האובייקט יוצג באפליקציה. לדוגמה, אובייקט |
barcode |
סוג הברקוד והערך שלו. |
messages[] |
מערך של הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות המשויכות אליו. המספר המקסימלי של השדות האלה הוא 10. |
valid |
תקופת הזמן של האובייקט הזה תהיה |
locations[] |
הערה: בשלב הזה אין תמיכה בשדה הזה להפעלת התראות גיאוגרפיות. |
has |
מציין אם יש לאובייקט משתמשים. השדה הזה מוגדר על ידי הפלטפורמה. |
smart |
הערך שיישלח לאובייקט הזה למסוף מאושר של Smart Tap באמצעות NFC. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר בצורה נכונה גם את השדות |
has |
אם האובייקט הזה מקושר כרגע למכשיר אחד. השדה הזה מוגדר על ידי הפלטפורמה כשמשתמש שומר את האובייקט ומקשר אותו למכשיר שלו. מיועד לשימוש של שותפים נבחרים. לקבלת מידע נוסף, אפשר לפנות לתמיכה. |
disable |
מציין אם צריך לדכא את ההתראות באופן מפורש. אם השדה הזה מוגדר כ-True, ללא קשר לשדה נכון לעכשיו, אפשר להגדיר את זה רק למבצעים. |
info |
הוצא משימוש. במקום זאת, צריך להשתמש ב-textModulesData. |
image |
נתוני מודול התמונה. המספר המקסימלי של השדות האלה שמוצגים הוא 1 ברמת האובייקט ו-1 ברמת אובייקט הכיתה. |
text |
נתונים של מודול טקסט. אם גם נתונים של מודול טקסט מוגדרים בכיתה, יוצגו שניהם. המספר המקסימלי של השדות האלה שמוצגים הוא 10 מהאובייקט ו-10 מהכיתה. |
links |
נתוני המודול. אם הנתונים של מודול הקישורים מוגדרים גם בכיתה, יוצגו שניהם. |
app |
קישור אופציונלי לאפליקציה או לאתר שיוצג כלחצן בחזית הכרטיס. אם יסופקו נתוני AppLinkData לסיווג המתאים, יוצגו רק נתוני AppLinkData של האובייקט. |
rotating |
הסוג והערך של הברקוד המסתובב. |
hero |
תמונת באנר אופציונלית שמוצגת בחזית הכרטיס. אם לא, תוצג תמונת ה-Hero של הכיתה, אם יש כזו. אם גם תמונת ה-Hero של הכיתה לא תופיע, לא יוצג כלום. |
grouping |
מידע שקובע איך הכרטיסים מקובצים יחד. |
pass |
מעבירים את האילוצים של האובייקט. כולל הגבלת ההתנהגויות של NFC וצילומי מסך. |
save |
הגבלות על האובייקט שצריך לאמת לפני שהמשתמש ינסה לשמור את הכרטיס. חשוב לזכור שההגבלות האלה יחולו רק במהלך זמן השמירה. אם ההגבלות השתנו אחרי שהמשתמש שמר את הכרטיס, ההגבלות החדשות לא יחולו על כרטיס שכבר נשמר. |
linked |
linkedObjectIds היא רשימה של אובייקטים אחרים, כמו כרטיס לאירוע, כרטיס מועדון לקוחות, מבצע, אובייקט כללי, כרטיס מתנה, כרטיס לתחבורה ציבורית וכרטיס עלייה למטוס, שצריך לצרף באופן אוטומטי לאובייקט כרטיס המתנה הזה. אם משתמש שמר את כרטיס המתנה הזה, מזהי ה-linkedObjectIds האלה יועברו באופן אוטומטי לארנק של המשתמש (אלא אם הוא השבית את ההגדרה לקבלת כרטיסים מקושרים כאלה). חשוב לוודא שהאובייקטים שמופיעים ב-linkedObjectIds כבר הוכנסו – אחרת הקריאות ייכשל. לאחר הקישור, לא ניתן לבטל את הקישור של האובייקטים המקושרים. אי אפשר לקשר אובייקטים ששייכים למנפיק אחר. יש מגבלה על מספר האובייקטים שאפשר לקשר לאובייקט יחיד. כשמגיעים למגבלה, המערכת מתעלמת מאובייקטים מקושרים חדשים בשיחה בלי להציג התראות. מזהי האובייקטים צריכים להיות בפורמט issuer ID.identifier, כאשר הראשון מונפק על ידי Google והשני נבחר על ידכם. |
notify |
האם עדכוני שדות באובייקט הזה יפעילו התראות. אם הערך שמוגדר הוא NOTIFY, ננסה לשלוח למשתמשים התראה על עדכון שדות. ההתראות האלה יישלחו למשתמשים רק אם השדה נכלל ברשימת ההיתרים. אם הערך מוגדר כ-DO_NOT_NOTIFY או כ-NOTIFICATION_SETTINGS_UNSPECIFIED, לא תופעל התראה. ההגדרה הזו היא זמנית וצריך להגדיר אותה בכל בקשת PATCH או UPDATE, אחרת לא תופעל התראה. |
value |
נתונים אופציונליים של מודול עם ערך מוסף. עד עשר באותו אובייקט. |
שיטות |
|
---|---|
|
הוספת הודעה לאובייקט של כרטיס המתנה שמוזכר במזהה האובייקט הנתון. |
|
הפונקציה מחזירה את אובייקט כרטיס המתנה עם מזהה האובייקט שצוין. |
|
הוספת אובייקט של כרטיס מתנה עם המזהה והמאפיינים הנתונים. |
|
הפונקציה מחזירה רשימה של כל אובייקטי כרטיסי המתנה למזהה מנפיק נתון. |
|
עדכון של אובייקט כרטיס המתנה שמשויך למזהה האובייקט הנתון. |
|
עדכון של אובייקט כרטיס המתנה שמשויך למזהה האובייקט הנתון. |