REST Resource: offerobject

משאב: OfferObject

ייצוג ב-JSON 
{
  "kind": string,
  "classReference": {
    object (OfferClass)
  },
  "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#offerObject".
classReference

object (OfferClass)

עותק של השדות שעברו בירושה מכיתה ההורה. השדות האלה מאוחזרים במהלך קריאה מסוג GET.
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

הערך שיישלח לאובייקט הזה למסוף מאושר של Smart Tap באמצעות NFC. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר בצורה נכונה גם את השדות enableSmartTap ו-redemptionIssuers ברמת הכיתה. יש תמיכה רק בתווי ASCII.
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 של הכיתה, אם יש כזו. אם גם תמונת ה-Hero של הכיתה לא תופיע, לא יוצג כלום.
groupingInfo

object (GroupingInfo)

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

object (PassConstraints)

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

object (SaveRestrictions)

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

string

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

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

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

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

שיטות

addmessage

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

get

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

insert

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

list

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

patch

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

update

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