REST Resource: genericobject

משאב: genObject

מזהה אובייקט גנרי הבא: 121

ייצוג 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,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  }
}
שדות
genericType

enum (GenericType)

יש לציין לאיזה GenericType הכרטיס שייך.
cardTitle

object (LocalizedString)

חובה. הכותרת של הכרטיס. בדרך כלל זה שם העסק, למשל "XXX Gym", "ביטוח 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

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

object (RotatingBarcode)

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

enum (State)

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

boolean

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

object (PassConstraints)

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

GenericType

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

טיפוסים בני מנייה (enums)
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_OTHER סוג אחר

התראות

שדה זה מציין אם צריך להפעיל התראות באובייקט. אנחנו תומכים רק בהתראה אחת או בהתראה הבאה. המדיניות 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

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