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)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
שדות
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[]
(deprecated)

object (LatLongPoint)

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

boolean

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

string

הערך שיישלח לאובייקט הזה למסוף מאושר של Smart Tap באמצעות 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 וצילומי מסך.
saveRestrictions

object (SaveRestrictions)

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

string

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

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

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

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

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

יתרה בצורת מחרוזת. צריך לאכלס רק אחד מהתת-טיפוסים האלה (string, ‏ int, ‏ double, ‏ money).
int

integer

הצורה של היתרה כמספר שלם. צריך לאכלס רק אחד מהתת-טיפוסים האלה (string, ‏ int, ‏ double, ‏ money).
double

number

הצורה הכפולה של היתרה. צריך לאכלס רק אחד מהתת-טיפוסים האלה (string, ‏ int, ‏ double, ‏ money).
money

object (Money)

הצורה הכספית של היתרה. צריך לאכלס רק אחד מהתת-טיפוסים האלה (string, ‏ int, ‏ double, ‏ money).

Methods

addmessage

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

get

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

insert

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

list

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

modifylinkedofferobjects

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

patch

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

update

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