REST Resource: loyaltyobject

{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}

string

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

object (LoyaltyClass)

עותק של השדות שעברו בירושה של מחלקת ההורה. השדות האלה מאוחזרים במהלך אחזור נתונים (GET).

string

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

string

המזהה של חשבון מועדון הלקוחות. האורך המקסימלי המומלץ הוא 20 תווים.

object (LoyaltyPoints)

תווית הנקודות של מועדון הלקוחות, היתרה והסוג שלו.

string

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

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

object (LoyaltyPoints)

התווית המשנית של נקודות המועדון, היתרה והסוג. מוצג בנוסף לנקודות המועדון הראשיות.

string

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

string

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

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

string (int64 format)

הוצא משימוש

enum (State)

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

object (Barcode)

סוג הברקוד והערך שלו.

object (Message)

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

object (TimeInterval)

תקופת הזמן של האובייקט הזה תהיה active ואפשר להשתמש באובייקט. המצב של אובייקט ישתנה ל-expired לאחר פרק הזמן הזה.

object (LatLongPoint)

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

boolean

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

string

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

אם הערך הזה לא מוגדר אבל השדות enableSmartTap ו-redemptionIssuers ברמת הכיתה מוגדרים כמו שצריך, השדות barcode.value או accountId ישמשו כחלופה, אם הם קיימים.

boolean

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

boolean

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

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

object (InfoModuleData)

הוצא משימוש. במקומו צריך להשתמש ב-textModulesData.

object (ImageModuleData)

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

object (TextModuleData)

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

object (LinksModuleData)

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

object (AppLinkData)

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

object (RotatingBarcode)

הסוג והערך של הברקוד המסתובב.

object (Image)

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

object (GroupingInfo)

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

object (PassConstraints)

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

object (SaveRestrictions)

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

{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}

string

התווית של נקודות המועדון, למשל 'נקודות'. האורך המקסימלי המומלץ הוא 9 תווים.

object (LoyaltyPointsBalance)

יתרת נקודות המועדון של בעל החשבון, למשל '500'. או '$10.00'. האורך המקסימלי המומלץ הוא 7 תווים. זהו שדה חובה של loyaltyPoints ו-secondaryLoyaltyPoints.

object (LocalizedString)

מחרוזות מתורגמות של התווית. האורך המקסימלי המומלץ הוא 9 תווים.

{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}

string

צורת המחרוזת של יתרה. צריך לאכלס רק אחד מסוגי המשנה האלה (string, int, double, Money).

integer

צורת המספר השלם של יתרה. צריך לאכלס רק אחד מסוגי המשנה האלה (string, int, double, Money).

number

צורה כפולה של יתרה. צריך לאכלס רק אחד מסוגי המשנה האלה (string, int, double, Money).

object (Money)

צורה כספית של יתרה. צריך לאכלס רק אחד מסוגי המשנה האלה (string, int, double, Money).