REST Resource: giftcardclass

משאב: ItemCardClass

ייצוג 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)
  }
}
שדות
kind
(deprecated)

string

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

string

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

string

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

string

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

boolean

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

object (LocalizedString)

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

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)

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

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

string

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

object (Image)

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

object (Image)

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

boolean

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

string

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

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