REST Resource: genericobject

{
  "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)
  }
}

enum (GenericType)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (Image)

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

string

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

object (Notifications)

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

string

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

string

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

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

object (Barcode)

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

object (Image)

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

object (TimeInterval)

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

object (ImageModuleData)

נתונים של מודול התמונה. רק תמונה אחת מהמחלקה ואחת מרמת האובייקט יוצגו אם שתיהן יוגדרו.

object (TextModuleData)

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

object (LinksModuleData)

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

object (AppLinkData)

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

object (GroupingInfo)

מידע שקובע איך הכרטיסים מקובצים יחד.

string

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

object (RotatingBarcode)

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

enum (State)

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

boolean

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

object (PassConstraints)

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

object (Image)

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

object (SaveRestrictions)

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

{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}

object (ExpiryNotification)

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

object (UpcomingNotification)

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

{
  "enableNotification": boolean
}

boolean

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

{
  "enableNotification": boolean
}

boolean

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