דף זה תורגם על ידי Cloud Translation API.

REST Resource: offerclass

משאב: OfferClass
- ייצוג ב-JSON
- RedemptionChannel
שיטות

משאב: OfferClass

ייצוג ב-JSON

ייצוג ב-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": 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% הנחה על כל חולצת טישרט באריזת לבוש".
`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 מהכיתה.
`linksModuleData`	`object (LinksModuleData)` נתוני המודול. אם הנתונים של מודול הקישורים מוגדרים גם באובייקט, יוצגו שניהם.
`redemptionIssuers[]`	`string (int64 format)` מזהה את מנפיקי השוברים שיכולים לממש את הכרטיס באמצעות 'הקשה חכמה'. מנפיקי מימושים מזוהים לפי מזהה המנפיק שלהם. למנפיקים של שוברי מימוש צריך להיות מוגדר לפחות מפתח אחד של Smart Tap. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדות `enableSmartTap` ו-`smartTapRedemptionLevel` ברמת האובייקט.
`countryCode`	`string` קוד המדינה שמשמש להצגת המדינה של הכרטיס (כשהמשתמש לא נמצא במדינה הזו), וגם להצגת תוכן מותאם כשהתוכן לא זמין באזור הגיאוגרפי של המשתמש.
`heroImage`	`object (Image)` תמונה אופציונלית של באנר שמוצגת בחזית הכרטיס. אם לא תהיה כותרת, לא יוצג דבר. התמונה תוצג ברוחב של 100%.
`wordMark (deprecated)`	`object (Image)` הפריט הזה הוצא משימוש! הוצא משימוש.
`enableSmartTap`	`boolean` מזהה אם הכיתה הזו תומכת בהקשה חכמה. גם השדות `redemptionIssuers` וברמת האובייקט `smartTapRedemptionLevel` צריכים להיות מוגדרים כראוי כדי שכרטיס יתמוך בתכונה 'הקשה חכמה'.
`hexBackgroundColor`	`string` צבע הרקע של הכרטיס. אם לא תגדירו צבע, המערכת תשתמש בצבע השולט בתמונת ה-Hero. אם לא תגדירו תמונה ראשית, המערכת תשתמש בצבע השולט בלוגו. הפורמט הוא #`rrggbb`, כאשר `rrggbb` הוא טריופל RGB ב-hex, למשל `#ffcc00`. אפשר גם להשתמש בקיצור של טריופל RGB, שהוא #`rgb`, למשל `#fc0`.
`localizedIssuerName`	`object (LocalizedString)` מחרוזות מתורגמות של המנפיק שם. האורך המקסימלי המומלץ הוא 20 תווים, כדי שהמחרוזת תוצג במלואה במסכים קטנים יותר.
`multipleDevicesAndHoldersAllowedStatus`	`enum (MultipleDevicesAndHoldersAllowedStatus)` האפשרות הזו קובעת אם מספר משתמשים ומכשירים ישמרו את אותו אובייקט שמתייחס לכיתה הזו.
`callbackOptions`	`object (CallbackOptions)` אפשרויות קריאה חוזרת (callback) שישמשו לקריאה חוזרת למנפיק בכל פעם שמשתמש הקצה שומר או מחק אובייקט מהסוג הזה. כל האובייקטים במחלקה הזו עומדים בדרישות להתקשרות חזרה.
`securityAnimation`	`object (SecurityAnimation)` מידע אופציונלי על אנימציית האבטחה. אם המדיניות הזו מוגדרת, תוצג אנימציית אבטחה בפרטי הכרטיס.
`viewUnlockRequirement`	`enum (ViewUnlockRequirement)` הצגת האפשרויות שנדרשות לביטול הנעילה למבצע.
`wideTitleImage`	`object (Image)` תמונת הכותרת הרחבה של המבצע. אם תספקו תמונה כזו, היא תוצג במקום תמונת השם בפינה הימנית העליונה של תצוגת הכרטיס.
`notifyPreference`	`enum (NotificationSettingsForUpdates)` אם עדכוני שדות של הכיתה הזו יפעילו התראות או לא. כשהערך מוגדר ל-NOTIFY, ננסה להפעיל התראה למשתמשים על עדכון השדה. ההתראות האלה יישלחו למשתמשים רק אם השדה נכלל ברשימת ההיתרים. אם לא יצוין ערך, לא תופעל התראה. ההגדרה הזו היא זמנית וצריך להגדיר אותה בכל בקשת PATCH או UPDATE, אחרת לא תופעל התראה.
`appLinkData`	`object (AppLinkData)` קישור אופציונלי לאתר או לאפליקציה שיוצג כלחצן בחזית הכרטיס. אם מציינים את AppLinkData לאובייקט המתאים, המערכת תשתמש בו במקום זאת.
`valueAddedModuleData[]`	`object (ValueAddedModuleData)` נתונים אופציונליים של מודול עם ערך מוסף. עד עשרה בכיתה. לגבי כרטיס, יוצגו רק עשרה, והעדיפות תהיה לנתונים מהעצם.

RedemptionChannel

טיפוסים בני מנייה (enum)
`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`	עדכון של קטגוריית המבצע שמשויך אליה מזהה הכיתה שצוין.

REST Resource: offerclass

משאב: OfferClass

RedemptionChannel

שיטות

`addmessage`

`get`

`insert`

`list`

`patch`

`update`