REST Resource: loyaltyobject

משאב: LoyaltyObject

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

string

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

object (LoyaltyClass)

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

string

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

string

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

object (LoyaltyPoints)

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

string

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

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

object (LoyaltyPoints)

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

string

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

string

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

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

string (int64 format)

הוצא משימוש
state

enum (State)

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

object (Barcode)

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

object (Message)

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

object (TimeInterval)

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

object (LatLongPoint)

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

boolean

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

string

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

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

boolean

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

boolean

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

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

object (InfoModuleData)

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

object (ImageModuleData)

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

object (TextModuleData)

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

object (RotatingBarcode)

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

object (Image)

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

object (GroupingInfo)

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

object (PassConstraints)

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

LoyaltyPoints

ייצוג JSON 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
שדות
label

string

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

object (LoyaltyPointsBalance)

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

object (LocalizedString)

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

LoyaltyPointsBalance

ייצוג JSON 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
שדות
string

string

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

integer

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

number

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

object (Money)

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

שיטות

addmessage

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

get

 מחזירה את אובייקט הנאמנות עם מזהה האובייקט הנתון.

insert

 הוספת אובייקט נאמנות עם המזהה והמאפיינים הנתונים.

list

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

modifylinkedofferobjects

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

patch

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

update

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