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)
  }
}
שדות
kind
(deprecated)

string

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

string

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

enum (RedemptionChannel)

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

string

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

object (Image)

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

string

פרטי המבצע.
finePrint

string

האותיות הקטנות או תנאי המבצע, כמו "20% הנחה על כל חולצת טישרט של אלי".
helpUri

object (Uri)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

מחרוזות מתורגמות עבור paymentprint.
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[]

object (LatLongPoint)

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

enum (ReviewStatus)

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

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

string

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

object (Image)

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

object (Image)

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

boolean

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

string

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

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

מזהה אם כמה משתמשים ומכשירים ישמרו את אותו אובייקט שקשור למחלקה הזו.
callbackOptions

object (CallbackOptions)

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

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

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

object (Image)

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

RedemptionChannel

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

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

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

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

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

שיטות

addmessage

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

get

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

insert

 הוספת רמת מבצע עם המזהה והמאפיינים הנתונים.

list

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

patch

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

update

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