REST Resource: giftcardclass

משאב: GiftCardClass

ייצוג ב-JSON 
{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
שדות
kind
(deprecated)

string

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

string

שם המוכר, למשל 'Adam's Apparel'. יכול להיות שבאפליקציה יוצג קו נטוי (ellipsis) אחרי 20 התווים הראשונים, כדי להבטיח שהמחרוזת המלאה תוצג במסכים קטנים יותר.
pinLabel

string

התווית שמוצגת לצד קוד האימות, למשל 'קוד אימות בן 4 ספרות'.
eventNumberLabel

string

התווית שמוצגת עבור מספר האירוע, למשל 'אירוע יעד מס'.
allowBarcodeRedemption

boolean

המערכת קובעת אם המוכר תומך במימוש כרטיס מתנה באמצעות סריקה של קוד מוטבע. אם הערך הוא True, האפליקציה תציג ברקוד של כרטיס המתנה במסך 'פרטי כרטיס המתנה'. אם הערך הוא false, הברקוד לא מוצג.
localizedMerchantName

object (LocalizedString)

מחרוזות מתורגמות של merchantName. יכול להיות שבאפליקציה יוצג קו נטוי (ellipsis) אחרי 20 התווים הראשונים, כדי להבטיח שהמחרוזת המלאה תוצג במסכים קטנים יותר.
localizedPinLabel

object (LocalizedString)

מחרוזות מתורגמות של pinLabel.
localizedEventNumberLabel

object (LocalizedString)

מחרוזות מתורגמות של eventNumberLabel.
cardNumberLabel

string

התווית שמוצגת לצד מספר הכרטיס, למשל 'מספר כרטיס'.
localizedCardNumberLabel

object (LocalizedString)

מחרוזות מתורגמות של cardNumberLabel.
classTemplateInfo

object (ClassTemplateInfo)

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

string

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

string (int64 format)

הוצא משימוש
issuerName

string

חובה. שם המנפיק האורך המקסימלי המומלץ הוא 20 תווים, כדי שהמחרוזת תוצג במלואה במסכים קטנים יותר.
messages[]

object (Message)

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

boolean

הוצא משימוש. במקום זאת, אתם צריכים להשתמש ב-multipleDevicesAndHoldersAllowedStatus.
homepageUri

object (Uri)

ה-URI של דף הבית של האפליקציה. האכלוס של ה-URI בשדה הזה גורם לאותה התנהגות בדיוק כמו האכלוס של ה-URI ב-linksModuleData (כשאובייקט מנוהל, קישור לדף הבית מוצג במקום שנחשב בדרך כלל לקטע linksModuleData של האובייקט).
locations[]
(deprecated)

object (LatLongPoint)

הערה: בשלב הזה אין תמיכה בשדה הזה להפעלת התראות גיאוגרפיות.
reviewStatus

enum (ReviewStatus)

חובה. הסטטוס של הכיתה. אפשר להגדיר את השדה הזה לערך draft או underReview באמצעות קריאות ה-API insert,‏ patch או update. אחרי שמצב הבדיקה ישתנה מ-draft, לא תהיה אפשרות לחזור למצב draft.

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

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

כשמעדכנים כיתה שכבר מוגדרת כ-approved, צריך להמשיך להגדיר את השדה הזה כ-underReview.
review

object (Review)

תגובות הבדיקה שמוגדרות על ידי הפלטפורמה כשכיתה מסומנת בסטטוס approved או rejected.
infoModuleData
(deprecated)

object (InfoModuleData)

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

object (ImageModuleData)

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

object (TextModuleData)

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

string (int64 format)

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

גם השדות enableSmartTap וברמת האובייקט smartTapRedemptionLevel צריכים להיות מוגדרים כראוי כדי שכרטיס יתמוך בתכונה 'הקשה חכמה'.
countryCode

string

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

object (Image)

תמונה אופציונלית של באנר שמוצגת בחזית הכרטיס. אם לא תהיה כותרת, לא יוצג דבר. התמונה תוצג ב-100% רוחב.
wordMark
(deprecated)

object (Image)

הוצא משימוש.
enableSmartTap

boolean

מזהה אם הכיתה הזו תומכת בהקשה חכמה. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדות redemptionIssuers ו-smartTapRedemptionLevel ברמת האובייקט.
hexBackgroundColor

string

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

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

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

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

שיטות

addmessage

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

get

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

insert

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

list

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

patch

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

update

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