משאב: EventTicketObject
ייצוג ב-JSON |
---|
{ "kind": string, "classReference": { object ( |
שדות | |
---|---|
kind |
מזהה את סוג המשאב. ערך: המחרוזת הקבועה |
class |
עותק של השדות שעברו בירושה של מחלקת ההורה. השדות האלה מאוחזרים במהלך קריאה מסוג GET. |
seat |
פרטי הישיבה בכרטיס הזה. |
reservation |
פרטי ההזמנה של הכרטיס הזה. ההנחה אמורה להתחלק בין כל הכרטיסים שנרכשו באותה הזמנה. |
ticket |
השם של בעל הכרטיס, אם הכרטיס מוקצה לאדם. לדוגמה, 'יוסי לוי' או 'יעל לוי'. |
ticket |
מספר הכרטיס. המזהה הזה יכול להיות מזהה ייחודי לכל הכרטיסים במערכת של המנפיק, כל הכרטיסים לאירוע (למשל: XYZ1234512345) או כל הכרטיסים שבהזמנה (1, 2, 3 וכו'). |
ticket |
סוג הכרטיס, למשל 'מבוגר' או 'ילד', או 'VIP' או 'רגיל'. |
face |
הערך הנקוב של הכרטיס, שתואם לערך שיודפס בגרסה הפיזית של הכרטיס. |
grouping |
מידע שקובע את אופן הקיבוץ של הכרטיסים. |
linked |
רשימה של אובייקטים של מבצעים שמקושרים לכרטיס לאירוע הזה. אובייקטי המבצע חייבים להיות קיימים. מזהי אובייקטים של מוצרים צריכים להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם. |
hex |
צבע הרקע של הכרטיס. אם לא תגדירו צבע, המערכת תשתמש בצבע השולט בתמונת ה-Hero. אם לא תגדירו תמונה ראשית, המערכת תשתמש בצבע השולט בלוגו. הפורמט הוא #rrggbb, כאשר rrggbb הוא טריופל RGB הקסדצימלי, כמו |
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 של הכיתה לא תופיע, לא יוצג כלום. |
pass |
מעבירים את האילוצים של האובייקט. כולל הגבלת ההתנהגויות של NFC וצילומי מסך. |
save |
הגבלות על האובייקט שצריך לאמת לפני שהמשתמש ינסה לשמור את הכרטיס. חשוב לזכור שההגבלות האלה יחולו רק במהלך זמן השמירה. אם ההגבלות השתנו אחרי שהמשתמש שמר את הכרטיס, ההגבלות החדשות לא יחולו על כרטיס שכבר נשמר. |
linked |
linkedObjectIds היא רשימה של אובייקטים אחרים, כמו כרטיס אירוע, כרטיס מועדון לקוחות, מבצע, כרטיס גנרי, כרטיס מתנה, כרטיס לתחבורה ציבורית וכרטיס עלייה למטוס, שצריך לצרף באופן אוטומטי לאובייקט כרטיס האירוע הזה. אם משתמש שמר את כרטיס האירוע הזה, מזהי ה-linkedObjectIds האלה יועברו באופן אוטומטי לארנק של המשתמש (אלא אם הוא השבית את ההגדרה לקבלת כרטיסים מקושרים כאלה). חשוב לוודא שהאובייקטים שמופיעים ב-linkedObjectIds כבר הוכנסו – אחרת הקריאות ייכשל. אחרי שמקשרים אובייקטים, אי אפשר לבטל את הקישור שלהם. אי אפשר לקשר אובייקטים ששייכים למנפיק אחר. יש מגבלה על מספר האובייקטים שאפשר לקשר לאובייקט יחיד. כשמגיעים למגבלה, המערכת מתעלמת מאובייקטים מקושרים חדשים בשיחה בלי להציג התראות. מזהי אובייקטים צריכים להיות בפורמט issuer ID.identifier, כאשר הראשון מונפק על ידי Google והשני נבחר על ידכם. |
notify |
האם עדכוני שדה לאובייקט הזה יפעילו התראות. כשהערך מוגדר ל-NOTIFY, ננסה להפעיל התראה למשתמשים על עדכון השדה. ההתראות האלה יישלחו למשתמשים רק אם השדה הוא חלק מרשימת היתרים. אם ההגדרה היא DO_NOT_NOTIFY או NOTIFICATION_SETTINGS_UNSPECIFIED, לא תישלח התראה. ההגדרה הזו היא זמנית וצריך להגדיר אותה בכל בקשת PATCH או UPDATE, אחרת לא תופעל התראה. |
value |
נתונים אופציונליים של מודול עם ערך מוסף. עד עשר באותו אובייקט. |
EventSeat
ייצוג ב-JSON |
---|
{ "kind": string, "seat": { object ( |
שדות | |
---|---|
kind |
מזהה את סוג המשאב. ערך: המחרוזת הקבועה |
seat |
מספר המושב, למשל '1', '2', '3' או כל מזהה אחר של מושב. השדה הזה ניתן להתאמה לשוק המקומי, כך שתוכלו לתרגם מילים או להשתמש באלפבית שונה לתווים במזהה. |
row |
השורה של המושב, למשל '1', 'E', 'BB' או 'A5'. השדה הזה ניתן להתאמה לשוק המקומי, כך שתוכלו לתרגם מילים או להשתמש באלפבית שונה לתווים במזהה. |
section |
הקטע של המושב, למשל '121'. השדה הזה ניתן להתאמה לשוק המקומי, כך שתוכלו לתרגם מילים או להשתמש באלפבית שונה לתווים במזהה. |
gate |
השער שבו בעל הכרטיס צריך להיכנס כדי להגיע למושב שלו, למשל 'A' או 'מערב'. השדה הזה ניתן להתאמה לשוק המקומי, כך שתוכלו לתרגם מילים או להשתמש באלפבית שונה לתווים במזהה. |
EventReservationInfo
ייצוג ב-JSON |
---|
{ "kind": string, "confirmationCode": string } |
שדות | |
---|---|
kind |
מזהה את סוג המשאב. ערך: המחרוזת הקבועה |
confirmation |
קוד האישור של ההזמנה לאירוע. המזהה יכול להיות גם 'מספר הזמנה', 'מספר אישור', 'מספר הזמנה' או שם מקביל אחר. |
שיטות |
|
---|---|
|
הוספת הודעה לאובייקט של כרטיס האירוע שמשויך למזהה האובייקט הנתון. |
|
הפונקציה מחזירה את אובייקט הכרטיס לאירוע עם מזהה האובייקט הנתון. |
|
הוספת אובייקט של כרטיס לאירוע עם המזהה והמאפיינים שצוינו. |
|
הפונקציה מחזירה רשימה של כל אובייקטי הכרטיסים לאירועים עבור מזהה מנפיק נתון. |
|
שינוי האובייקטים של המבצע המקושר לאובייקט הכרטיס לאירוע עם המזהה הנתון. |
|
מעדכן את אובייקט כרטיס האירוע שאליו מפנה מזהה האובייקט הנתון. |
|
הקוד מעדכן את אובייקט כרטיס האירוע שמוזכר במזהה האובייקט שצוין. |