REST Resource: offerclass

משאב: OfferClass

ייצוג ב-JSON 
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    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),
  "wideTitleImage": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
שדות
kind
(deprecated)

string

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

string

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

enum (RedemptionChannel)

חובה. ערוצי המימוש שחלים על המבצע הזה.
provider

string

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

object (Image)

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

string

פרטי המבצע.
finePrint

string

האותיות הקטנות או התנאים של המבצע, למשל '20% הנחה על כל חולצת טי ב-Adam's Apparel'.
helpUri

object (Uri)

קישור העזרה של המבצע, למשל http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

מחרוזות מתורגמות של הפרטים.
localizedFinePrint

object (LocalizedString)

מחרוזות מתורגמות של האותיות הקטנות.
shortTitle

string

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

object (LocalizedString)

מחרוזות מתורגמות של השם הקצר. האורך המקסימלי המומלץ הוא 20 תווים.
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[]
(deprecated)

object (LatLongPoint)

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

enum (ReviewStatus)

חובה. הסטטוס של הכיתה. אפשר להגדיר בשדה הזה את הערך draft או את סטטוס הכיתה. אפשר להגדיר את השדה הזה לערך draft או underReview באמצעות קריאות ה-API insert,‏ patch או update. אחרי שסטטוס הבדיקה משתנה מ-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. מנפיקי שוברי המימוש מזוהים לפי מזהה המנפיק שלהם. למנפיקים של שוברי מימוש צריך להיות מוגדר לפחות מפתח אחד של Smart Tap.

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

string

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

object (Image)

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

object (Image)

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

boolean

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

string

צבע הרקע של הכרטיס. אם לא תגדירו צבע, המערכת תשתמש בצבע השולט בתמונה הראשית. אם לא תגדירו תמונה ראשית, המערכת תשתמש בצבע השולט בלוגו. הפורמט הוא #rrggbb, כאשר rrggbb הוא טריופל RGB ב-hex, למשל #ffcc00. אפשר גם להשתמש בקיצור של טריופל RGB, שהוא #rgb, למשל #fc0.
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

אפשרויות קריאה חוזרת (callback) שישמשו לקריאה חוזרת למנפיק בכל פעם שמשתמש הקצה שומר או מחק אובייקט מהסוג הזה. כל האובייקטים מהסוג הזה עומדים בדרישות להפעלת פונקציית ה-callback.
securityAnimation

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

בודקים את האפשרויות של דרישת הנעילה למבצע.
wideTitleImage

object (Image)

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

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

RedemptionChannel

טיפוסים בני מנייה (enum)
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

כתובת אימייל חלופית מדור קודם של INSTORE. הוצא משימוש.
ONLINE
online

כתובת אימייל חלופית מדור קודם של ONLINE. הוצא משימוש.
BOTH
both

כתובת אימייל חלופית מדור קודם של BOTH. הוצא משימוש.
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

כתובת אימייל חלופית מדור קודם של TEMPORARY_PRICE_REDUCTION. הוצא משימוש.

Methods

addmessage

 הוספת הודעה לסוג המבצע שמשויך למזהה הסוג הנתון.

get

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

insert

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

list

 הפונקציה מחזירה רשימה של כל סוגי המוצרים למנפיק נתון.

patch

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

update

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