REST Resource: genericobject

משאב: GenericObject

אובייקט גנרי

ייצוג JSON 
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
שדות
genericType

enum (GenericType)

מציינים את GenericType שאליו שייך הכרטיס.
cardTitle

object (LocalizedString)

חובה. הכותרת של הכרטיס. בדרך כלל זהו שם העסק, למשל 'מכון הכושר XXX', 'ביטוח AAA'. השדה הזה הוא חובה והוא מופיע בשורת הכותרת בחלק העליון של הכרטיס.
subheader

object (LocalizedString)

תווית הכותרת של הכרטיס, למשל המיקום שבו אפשר להשתמש בכרטיס. מופיע ממש מעל השם בשורת הכותרת בתצוגת פרטי הכרטיס.
header

object (LocalizedString)

חובה. שם הכרטיס, למשל 'שובר הנחה של 50%', 'כרטיס ספרייה' או 'שובר'. השדה הזה הוא חובה והוא מופיע בשורת הכותרת בתצוגת הפרטים של הכרטיס.
hexBackgroundColor

string

צבע הרקע של הכרטיס. אם לא תגדירו צבע, המערכת תשתמש בצבע השולט בתמונה הראשית. אם לא תגדירו תמונה ראשית, המערכת תשתמש בצבע השולט בלוגו. אם לא תגדירו לוגו, Google תבחר צבע.
notifications

object (Notifications)

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

string

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

string

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

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

object (Barcode)

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

object (Image)

תמונת הבאנר שמוצגת בחזית הכרטיס, אם יש כזו. התמונה תוצג ב-100% רוחב.
validTimeInterval

object (TimeInterval)

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

object (ImageModuleData)

נתוני מודול התמונה. אם תגדירו את שתי התמונות, רק אחת מהן תעבור עיבוד – התמונה ברמת הכיתה או התמונה ברמת האובייקט.
textModulesData[]

object (TextModuleData)

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

object (GroupingInfo)

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

string

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

object (RotatingBarcode)

ההגדרות או הפרטים של הברקוד המסתובב.
state

enum (State)

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

boolean

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

object (Message)

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

object (PassConstraints)

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

object (SaveRestrictions)

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

object (ValueAddedModuleData)

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

string

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

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

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

GenericType

סוג הכרטיס הכללי.

טיפוסים בני מנייה (enum)
GENERIC_TYPE_UNSPECIFIED סוג כללי לא צוין.
GENERIC_SEASON_PASS כרטיס עונתי
GENERIC_UTILITY_BILLS חשבונות על תשתיות
GENERIC_PARKING_PASS כרטיס חניה
GENERIC_VOUCHER שובר
GENERIC_GYM_MEMBERSHIP כרטיסי מינוי למכון כושר
GENERIC_LIBRARY_MEMBERSHIP כרטיסי חברות בספרייה
GENERIC_RESERVATIONS הזמנות
GENERIC_AUTO_INSURANCE כרטיסי ביטוח רכב
GENERIC_HOME_INSURANCE כרטיסי ביטוח לבית
GENERIC_ENTRY_TICKET כרטיסי כניסה
GENERIC_RECEIPT קבלות
GENERIC_LOYALTY_CARD כרטיסי מועדון לקוחות. לתשומת ליבך: מומלץ להשתמש בסוג כרטיס ייעודי של מועדון לקוחות במקום בסוג הגנרי הזה. סוג כרטיס ייעודי של מועדון לקוחות כולל יותר תכונות ופונקציות בהשוואה לסוג הכרטיס הגנרי.
GENERIC_OTHER סוג אחר

התראות

מציין אם צריך להפעיל התראות לגבי האובייקט. אנחנו תומכים רק באחת מההתראות Expiry Notification/ההתראה הקרובה. expiryNotification מקבלת עדיפות על פני upcomingNotification. במילים אחרות, אם השדה expiryNotification מוגדר, המערכת מתעלמת מהשדה upcomingNotification.

ייצוג JSON 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
שדות
expiryNotification

object (ExpiryNotification)

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

object (UpcomingNotification)

תישלח התראה במועד ספציפי לפני שאפשר יהיה להשתמש בכרטיס.

ExpiryNotification

המשמעות היא שהמנפיק רוצה ש-Google Wallet תשלח התראות על תפוגת התוקף יומיים לפני תאריך התפוגה של הכרטיס.

ייצוג JSON 
{
  "enableNotification": boolean
}
שדות
enableNotification

boolean

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

UpcomingNotification

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

ייצוג ב-JSON 
{
  "enableNotification": boolean
}
שדות
enableNotification

boolean

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

שיטות

addmessage

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

get

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

insert

 מוסיפה אובייקט גנרי עם המזהה והמאפיינים הנתונים.

list

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

patch

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

update

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