REST Resource: genericobject

משאב: GeneralObject

אובייקט גנרי

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

enum (GenericType)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

string

צבע הרקע של הכרטיס. אם המדיניות לא מוגדרת, המערכת תשתמש בצבע הדומיננטי של התמונה הראשית (Hero). אם לא הוגדרה תמונה ראשית, המערכת תשתמש בצבע הדומיננטי של הלוגו. אם לא תגדירו את הלוגו, 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

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

object (PassConstraints)

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

object (SaveRestrictions)

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

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_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

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