משאב: EventTicketObject
ייצוג ב-JSON |
---|
{ "kind": string, "classReference": { object ( |
שדות | |
---|---|
kind |
מזהה את סוג המשאב. ערך: המחרוזת הקבועה |
classReference |
עותק של השדות שעברו בירושה מכיתה ההורה. השדות האלה מאוחזרים במהלך קריאה מסוג GET. |
seatInfo |
פרטי הישיבה בכרטיס הזה. |
reservationInfo |
פרטי ההזמנה של הכרטיס הזה. ההנחה אמורה להתחלק בין כל הכרטיסים שנרכשו באותה הזמנה. |
ticketHolderName |
השם של בעל הכרטיס, אם הכרטיס מוקצה לאדם. לדוגמה, 'יוסי לוי' או 'יעל לוי'. |
ticketNumber |
מספר הכרטיס. זה יכול להיות מזהה ייחודי לכל הכרטיסים במערכת של המנפיק, לכל הכרטיסים לאירוע (למשל XYZ1234512345) או לכל הכרטיסים בהזמנה (1, 2, 3 וכו'). |
ticketType |
סוג הכרטיס, למשל 'מבוגר' או 'ילד', או 'VIP' או 'רגיל'. |
faceValue |
הערך הנקוב של הכרטיס, שתואם לערך שיודפס בגרסה הפיזית של הכרטיס. |
groupingInfo |
מידע שקובע את אופן הקיבוץ של הכרטיסים. |
linkedOfferIds[] |
רשימה של אובייקטים של מבצעים שמקושרים לכרטיס לאירוע הזה. אובייקטי המבצע חייבים להיות קיימים. מזהי אובייקטים של מוצרים צריכים להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם. |
hexBackgroundColor |
צבע הרקע של הכרטיס. אם לא תגדירו צבע, המערכת תשתמש בצבע השולט בתמונה הראשית. אם לא תגדירו תמונה ראשית, המערכת תשתמש בצבע השולט בלוגו. הפורמט הוא #rrggbb, כאשר rrggbb הוא טריופל RGB הקסדצימלי, כמו |
id |
חובה. המזהה הייחודי של אובייקט. המזהה הזה חייב להיות ייחודי בכל האובייקטים של מנפיק. הערך צריך להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם. המזהה הייחודי צריך לכלול רק תווים אלפאנומריים, '.', '_' או '-'. |
classId |
חובה. הכיתה שמשויכת לאובייקט הזה. הכיתה צריכה להיות מאותו סוג כמו האובייקט הזה, היא כבר צריכה להתקיים והיא צריכה להיות מאושרת. מזהי הכיתות צריכים להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם. |
version |
הוצא משימוש |
state |
חובה. המצב של האובייקט. השדה הזה משמש לקביעת האופן שבו אובייקט מוצג באפליקציה. לדוגמה, אובייקט |
barcode |
סוג הברקוד והערך שלו. |
messages[] |
מערך של הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות המשויכות אליו. המספר המקסימלי של השדות האלה הוא 10. |
validTimeInterval |
פרק הזמן שבו האובייקט יהיה |
locations[] |
הערה: בשלב הזה אין תמיכה בשדה הזה כדי להפעיל התראות גיאוגרפיות. |
hasUsers |
מציין אם יש לאובייקט משתמשים. השדה הזה מוגדר על ידי הפלטפורמה. |
smartTapRedemptionValue |
הערך שיישלח לאובייקט הזה למסוף מאושר של Smart Tap באמצעות NFC. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדות |
hasLinkedDevice |
אם האובייקט הזה מקושר כרגע למכשיר אחד. השדה הזה מוגדר על ידי הפלטפורמה כשמשתמש שומר את האובייקט ומקשר אותו למכשיר שלו. מיועד לשימוש של שותפים נבחרים. לקבלת מידע נוסף, אפשר לפנות לתמיכה. |
disableExpirationNotification |
מציין אם צריך לדכא את ההתראות באופן מפורש. אם השדה הזה מוגדר כ-true, ללא קשר לשדה בשלב הזה אפשר להגדיר את האפשרות הזו רק למבצעים. |
infoModuleData |
הוצא משימוש. במקום זאת, צריך להשתמש ב-textModulesData. |
imageModulesData[] |
נתוני מודול התמונה. המספר המקסימלי של השדות האלה שמוצגים הוא 1 ברמת האובייקט ו-1 ברמת אובייקט הכיתה. |
textModulesData[] |
נתונים של מודול טקסט. אם מוגדרים גם נתונים של מודול טקסט בכיתה, יוצגו שניהם. המספר המקסימלי של השדות האלה שמוצגים הוא 10 מהאובייקט ו-10 מהכיתה. |
linksModuleData |
נתוני המודול 'קישורים'. אם הנתונים של מודול הקישורים מוגדרים גם בכיתה, יוצגו שניהם. |
appLinkData |
קישור אופציונלי לאפליקציה או לאתר שיוצג כלחצן בחזית הכרטיס. אם יסופקו נתוני AppLinkData לסיווג המתאים, יוצגו רק נתוני AppLinkData של האובייקט. |
rotatingBarcode |
הסוג והערך של הברקוד המסתובב. |
heroImage |
תמונה אופציונלית של באנר שמוצגת בחזית הכרטיס. אם לא תהיה תמונה כזו, תוצג תמונה ראשית של הכיתה, אם יש כזו. אם גם תמונת ה-Hero של הכיתה לא תופיע, לא יוצג כלום. |
passConstraints |
מעבירים את האילוצים של האובייקט. כולל הגבלת התנהגויות של NFC וצילומי מסך. |
saveRestrictions |
הגבלות על האובייקט שצריך לאמת לפני שהמשתמש ינסה לשמור את הכרטיס. חשוב לזכור שההגבלות האלה יחולו רק במהלך זמן השמירה. אם ההגבלות השתנו אחרי שהמשתמש שמר את הכרטיס, ההגבלות החדשות לא יחולו על כרטיס שכבר נשמר. |
linkedObjectIds[] |
linkedObjectIds היא רשימה של אובייקטים אחרים, כמו כרטיס לאירוע, כרטיס מועדון לקוחות, מבצע, כרטיס גנרי, כרטיס מתנה, כרטיס לתחבורה ציבורית וכרטיס עלייה למטוס, שצריך לצרף באופן אוטומטי לאובייקט הכרטיס לאירוע הזה. אם משתמש שמר את כרטיס האירוע הזה, מזהי ה-linkedObjectIds האלה יועברו באופן אוטומטי לארנק של המשתמש (אלא אם הוא השבית את ההגדרה לקבלת כרטיסים מקושרים כאלה). חשוב לוודא שהאובייקטים שמופיעים ב-linkedObjectIds כבר הוכנסו – אחרת הקריאות ייכשל. אחרי שמקשרים אובייקטים, אי אפשר לבטל את הקישור שלהם. אי אפשר לקשר אובייקטים ששייכים למנפיק אחר. יש מגבלה על מספר האובייקטים שאפשר לקשר לאובייקט יחיד. אחרי שמגיעים למגבלה, המערכת תתעלם בשקט מאובייקטים מקושרים חדשים בשיחה. מזהי אובייקטים צריכים להיות בפורמט issuer ID.identifier, כאשר הראשון מונפק על ידי Google והשני נבחר על ידכם. |
notifyPreference |
האם עדכוני שדות באובייקט הזה יפעילו התראות. כשהערך מוגדר ל-NOTIFY, אנחנו מנסים להפעיל התראה למשתמשים על עדכון השדה. ההתראות האלה יישלחו למשתמשים רק אם השדה נכלל ברשימת ההיתרים. אם הערך מוגדר כ-DO_NOT_NOTIFY או כ-NOTIFICATION_SETTINGS_UNSPECIFIED, לא תופעל התראה. ההגדרה הזו היא זמנית וצריך להגדיר אותה בכל בקשת PATCH או UPDATE, אחרת לא תופעל התראה. |
valueAddedModuleData[] |
נתונים אופציונליים של מודול עם ערך מוסף. עד עשר באותו אובייקט. |
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 |
מזהה את סוג המשאב. ערך: המחרוזת הקבועה |
confirmationCode |
קוד האישור של ההזמנה לאירוע. המזהה יכול להיות גם 'מספר הזמנה', 'מספר אישור', 'מספר הזמנה' או שם מקביל אחר. |
Methods |
|
---|---|
|
הוספת הודעה לאובייקט של כרטיס האירוע שמוזכר במזהה האובייקט הנתון. |
|
הפונקציה מחזירה את האובייקט של כרטיס האירוע עם מזהה האובייקט הנתון. |
|
הוספת אובייקט של כרטיס לאירוע עם המזהה והמאפיינים שצוינו. |
|
הפונקציה מחזירה רשימה של כל אובייקטי הכרטיסים לאירועים עבור מזהה מנפיק נתון. |
|
שינוי של אובייקטי המבצעים המקושרים לאובייקט של כרטיס האירוע עם המזהה הנתון. |
|
עדכון של אובייקט כרטיס האירוע שמוזכר במזהה האובייקט הנתון. |
|
עדכון של אובייקט כרטיס האירוע שמוזכר במזהה האובייקט הנתון. |