REST Resource: eventticketobject

משאב: EventTicketObject

ייצוג ב-JSON
{
  "kind": string,
  "classReference": {
    object (EventTicketClass)
  },
  "seatInfo": {
    object (EventSeat)
  },
  "reservationInfo": {
    object (EventReservationInfo)
  },
  "ticketHolderName": string,
  "ticketNumber": string,
  "ticketType": {
    object (LocalizedString)
  },
  "faceValue": {
    object (Money)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "linkedOfferIds": [
    string
  ],
  "hexBackgroundColor": string,
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
שדות
kind
(deprecated)

string

מזהה את סוג המשאב. ערך: המחרוזת הקבועה "walletobjects#eventTicketObject".

classReference

object (EventTicketClass)

עותק של השדות שעברו בירושה של מחלקת ההורה. השדות האלה מאוחזרים במהלך קריאה מסוג GET.

seatInfo

object (EventSeat)

פרטי הישיבה בכרטיס הזה.

reservationInfo

object (EventReservationInfo)

פרטי ההזמנה של הכרטיס הזה. ההנחה אמורה להתחלק בין כל הכרטיסים שנרכשו באותה הזמנה.

ticketHolderName

string

השם של בעל הכרטיס, אם הכרטיס מוקצה לאדם. לדוגמה, 'יוסי לוי' או 'יעל לוי'.

ticketNumber

string

מספר הכרטיס. המזהה הזה יכול להיות מזהה ייחודי לכל הכרטיסים במערכת של המנפיק, כל הכרטיסים לאירוע (למשל: XYZ1234512345) או כל הכרטיסים שבהזמנה (1, 2, 3 וכו').

ticketType

object (LocalizedString)

סוג הכרטיס, למשל 'מבוגר' או 'ילד', או 'VIP' או 'רגיל'.

faceValue

object (Money)

הערך הנקוב של הכרטיס, שתואם לערך שיודפס בגרסה הפיזית של הכרטיס.

groupingInfo

object (GroupingInfo)

מידע שקובע את אופן הקיבוץ של הכרטיסים.

linkedOfferIds[]

string

רשימה של אובייקטים של מבצעים שמקושרים לכרטיס לאירוע הזה. אובייקטי המבצע חייבים להיות קיימים.

מזהי אובייקטים של מוצרים צריכים להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם.

hexBackgroundColor

string

צבע הרקע של הכרטיס. אם לא תגדירו צבע, המערכת תשתמש בצבע השולט בתמונת ה-Hero. אם לא תגדירו תמונה ראשית, המערכת תשתמש בצבע השולט בלוגו. הפורמט הוא #rrggbb, כאשר rrggbb הוא טריופל RGB הקסדצימלי, כמו #ffcc00. אפשר גם להשתמש בגרסה המקוצרת של משולש ה-RGB שהיא #rgb, כמו למשל #fc0.

id

string

חובה. המזהה הייחודי של אובייקט. המזהה הזה חייב להיות ייחודי בכל האובייקטים של מנפיק. הערך צריך להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם. המזהה הייחודי יכול לכלול רק תווים אלפאנומריים, '.', '_' או '-'.

classId

string

חובה. המחלקה שמשויכת לאובייקט הזה. הכיתה צריכה להיות מאותו סוג כמו האובייקט הזה, היא כבר צריכה להתקיים והיא צריכה להיות מאושרת.

מזהי הכיתות צריכים להיות בפורמט issuer ID.identifier, כאשר המזהה הראשון מונפק על ידי Google והשני נבחר על ידכם.

version
(deprecated)

string (int64 format)

הוצא משימוש

state

enum (State)

חובה. מצב האובייקט. השדה הזה משמש לקביעת האופן שבו האובייקט יוצג באפליקציה. לדוגמה, אובייקט inactive מועבר לקטע 'כרטיסים שפג תוקפם'.

barcode

object (Barcode)

סוג הברקוד והערך שלו.

messages[]

object (Message)

מערך של הודעות שמוצגות באפליקציה. כל המשתמשים באובייקט הזה יקבלו את ההודעות המשויכות אליו. אפשר להוסיף עד 10 שדות כאלה.

validTimeInterval

object (TimeInterval)

פרק הזמן שבו האובייקט יהיה active ואפשר יהיה להשתמש בו. המצב של האובייקט ישתנה ל-expired כשפרק הזמן הזה יפוג.

locations[]
(deprecated)

object (LatLongPoint)

הערה: השדה הזה לא נתמך כרגע להפעלת התראות גיאוגרפיות.

hasUsers

boolean

מציין אם יש לאובייקט משתמשים. השדה הזה מוגדר על ידי הפלטפורמה.

smartTapRedemptionValue

string

הערך שיישלח לאובייקט הזה למסוף מאושר של Smart Tap באמצעות NFC. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר בצורה נכונה גם את השדות enableSmartTap ו-redemptionIssuers ברמת הכיתה. יש תמיכה רק בתווי ASCII.

hasLinkedDevice

boolean

אם האובייקט הזה מקושר כרגע למכשיר אחד. השדה הזה מוגדר על ידי הפלטפורמה כשמשתמש שומר את האובייקט ומקשר אותו למכשיר שלו. מיועד לשימוש של שותפים נבחרים. לקבלת מידע נוסף, אפשר לפנות לתמיכה.

disableExpirationNotification

boolean

מציין אם צריך לדכא את ההתראות באופן מפורש. אם השדה הזה מוגדר כ-true, ללא קשר לשדה messages, ההתראות על תפוגה לא יוצגו למשתמש. כברירת מחדל, השדה הזה מוגדר כ-false.

בשלב הזה אפשר להגדיר את האפשרות הזו רק למבצעים.

infoModuleData

object (InfoModuleData)

הוצא משימוש. במקום זאת, צריך להשתמש ב-textModulesData.

imageModulesData[]

object (ImageModuleData)

נתוני מודול התמונה. המספר המקסימלי של השדות האלה שמוצגים הוא 1 ברמת האובייקט ו-1 ברמת אובייקט הכיתה.

textModulesData[]

object (TextModuleData)

נתונים של מודול טקסט. אם גם נתונים של מודול טקסט מוגדרים בכיתה, יוצגו שניהם. המספר המקסימלי של השדות האלה שמוצגים הוא 10 מהאובייקט ו-10 מהכיתה.

rotatingBarcode

object (RotatingBarcode)

הסוג והערך של הברקוד המסתובב.

heroImage

object (Image)

תמונה אופציונלית של באנר שמוצגת בחזית הכרטיס. אם לא, תוצג תמונת ה-Hero של הכיתה, אם יש כזו. אם גם תמונת ה-Hero של הכיתה לא תופיע, לא יוצג כלום.

passConstraints

object (PassConstraints)

מעבירים את האילוצים של האובייקט. כולל הגבלת ההתנהגויות של NFC וצילומי מסך.

saveRestrictions

object (SaveRestrictions)

הגבלות על האובייקט שצריך לאמת לפני שהמשתמש ינסה לשמור את הכרטיס. חשוב לזכור שההגבלות האלה יחולו רק במהלך זמן השמירה. אם ההגבלות השתנו אחרי שהמשתמש שמר את הכרטיס, ההגבלות החדשות לא יחולו על כרטיס שכבר נשמר.

linkedObjectIds[]

string

linkedObjectIds היא רשימה של אובייקטים אחרים, כמו כרטיס אירוע, כרטיס מועדון לקוחות, מבצע, כרטיס גנרי, כרטיס מתנה, כרטיס לתחבורה ציבורית וכרטיס עלייה למטוס, שצריך לצרף באופן אוטומטי לאובייקט כרטיס האירוע הזה. אם משתמש שמר את כרטיס האירוע הזה, מזהי ה-linkedObjectIds האלה יועברו באופן אוטומטי לארנק של המשתמש (אלא אם הוא השבית את ההגדרה לקבלת כרטיסים מקושרים כאלה).

חשוב לוודא שהאובייקטים שמופיעים ב-linkedObjectIds כבר הוכנסו – אחרת הקריאות ייכשל. אחרי שמקשרים אובייקטים, אי אפשר לבטל את הקישור שלהם. אי אפשר לקשר אובייקטים ששייכים למנפיק אחר. יש מגבלה על מספר האובייקטים שאפשר לקשר לאובייקט יחיד. כשמגיעים למגבלה, המערכת מתעלמת מאובייקטים מקושרים חדשים בשיחה בלי להציג התראות.

מזהי אובייקטים צריכים להיות בפורמט issuer ID.identifier, כאשר הראשון מונפק על ידי Google והשני נבחר על ידכם.

notifyPreference

enum (NotificationSettingsForUpdates)

האם עדכוני שדה לאובייקט הזה יפעילו התראות. כשהערך מוגדר ל-NOTIFY, ננסה להפעיל התראה למשתמשים על עדכון השדה. ההתראות האלה יישלחו למשתמשים רק אם השדה הוא חלק מרשימת היתרים. אם ההגדרה היא DO_NOT_NOTIFY או NOTIFICATION_SETTINGS_UNSPECIFIED, לא תישלח התראה. ההגדרה הזו היא זמנית וצריך להגדיר אותה בכל בקשת PATCH או UPDATE, אחרת לא תופעל התראה.

valueAddedModuleData[]

object (ValueAddedModuleData)

נתונים אופציונליים של מודול עם ערך מוסף. עד עשר באותו אובייקט.

EventSeat

ייצוג ב-JSON
{
  "kind": string,
  "seat": {
    object (LocalizedString)
  },
  "row": {
    object (LocalizedString)
  },
  "section": {
    object (LocalizedString)
  },
  "gate": {
    object (LocalizedString)
  }
}
שדות
kind
(deprecated)

string

מזהה את סוג המשאב. ערך: המחרוזת הקבועה "walletobjects#eventSeat".

seat

object (LocalizedString)

מספר המושב, למשל '1', '2', '3' או כל מזהה אחר של מושב.

השדה הזה ניתן להתאמה לשוק המקומי, כך שתוכלו לתרגם מילים או להשתמש באלפבית שונה לתווים במזהה.

row

object (LocalizedString)

השורה של המושב, למשל '1', 'E', 'BB' או 'A5'.

השדה הזה ניתן להתאמה לשוק המקומי, כך שתוכלו לתרגם מילים או להשתמש באלפבית שונה לתווים במזהה.

section

object (LocalizedString)

הקטע של המושב, למשל '121'.

השדה הזה ניתן להתאמה לשוק המקומי, כך שתוכלו לתרגם מילים או להשתמש באלפבית שונה לתווים במזהה.

gate

object (LocalizedString)

השער שבו בעל הכרטיס צריך להיכנס כדי להגיע למושב שלו, למשל 'A' או 'מערב'.

השדה הזה ניתן להתאמה לשוק המקומי, כך שתוכלו לתרגם מילים או להשתמש באלפבית שונה לתווים במזהה.

EventReservationInfo

ייצוג ב-JSON
{
  "kind": string,
  "confirmationCode": string
}
שדות
kind
(deprecated)

string

מזהה את סוג המשאב. ערך: המחרוזת הקבועה "walletobjects#eventReservationInfo".

confirmationCode

string

קוד האישור של ההזמנה לאירוע. המזהה יכול להיות גם 'מספר הזמנה', 'מספר אישור', 'מספר הזמנה' או שם מקביל אחר.

שיטות

addmessage

הוספת הודעה לאובייקט של כרטיס האירוע שמשויך למזהה האובייקט הנתון.

get

הפונקציה מחזירה את אובייקט הכרטיס לאירוע עם מזהה האובייקט הנתון.

insert

הוספת אובייקט של כרטיס לאירוע עם המזהה והמאפיינים שצוינו.

list

הפונקציה מחזירה רשימה של כל אובייקטי הכרטיסים לאירועים עבור מזהה מנפיק נתון.

modifylinkedofferobjects

שינוי האובייקטים של המבצע המקושר לאובייקט הכרטיס לאירוע עם המזהה הנתון.

patch

מעדכן את אובייקט כרטיס האירוע שאליו מפנה מזהה האובייקט הנתון.

update

הקוד מעדכן את אובייקט כרטיס האירוע שמוזכר במזהה האובייקט שצוין.