REST Resource: giftcardclass

משאב: GIFCardClass

ייצוג 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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
שדות
kind
(deprecated)

string

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

merchantName

string

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

pinLabel

string

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

eventNumberLabel

string

התווית שתוצג עבור מספר האירוע, כגון 'Target Event #'.

allowBarcodeRedemption

boolean

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

localizedMerchantName

object (LocalizedString)

מחרוזות מתורגמות של MerchantName. כדי להבטיח שהמחרוזת המלאה תוצג במסכים קטנים יותר, האפליקציה עשויה להציג שלוש נקודות אחרי 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 ב-linkModuleData (כשאובייקט עובר עיבוד, קישור לדף הבית מוצג באופן שבדרך כלל נחשב כ-LinkModuleData של האובייקט).

locations[]

object (LatLongPoint)

הערה: השדה הזה לא נתמך כרגע להפעלת התראות גיאוגרפיות.

reviewStatus

enum (ReviewStatus)

חובה. הסטטוס של הכיתה. אפשר להגדיר את השדה הזה לערך draft או לערך underReview באמצעות הוספה, תיקון או עדכון של קריאות ל-API. אחרי שמצב הבדיקה ישתנה מ-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), משתמשים בתמונה הראשית (Hero) אם לא הגדרתם את הצבע הדומיננטי של הלוגו. הפורמט הוא #rrggbb, כאשר rrggbb הוא שלשה הקסדצימלית של RGB, למשל #ffcc00. אפשר גם להשתמש בגרסה המקוצרת של משולש ה-RGB שהיא #rgb, למשל #fc0.

localizedIssuerName

object (LocalizedString)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

securityAnimation

object (SecurityAnimation)

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

viewUnlockRequirement

enum (ViewUnlockRequirement)

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

שיטות

addmessage

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

get

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

insert

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

list

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

patch

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

update

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