REST Resource: loyaltyclass

משאב: LoyaltyClass

ייצוג ב-JSON 
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "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),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
שדות
kind
(deprecated)

string

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

string

חובה. שם התוכנית, למשל 'Adam's Apparel'. יכול להיות שבאפליקציה יוצג קו נטוי (ellipsis) אחרי 20 התווים הראשונים, כדי להבטיח שהמחרוזת המלאה תוצג במסכים קטנים יותר.
accountNameLabel

string

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

string

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

string

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

string

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

object (LocalizedString)

מחרוזות מתורגמות של programName. יכול להיות שבאפליקציה יוצג קו נטוי (ellipsis) אחרי 20 התווים הראשונים, כדי להבטיח שהמחרוזת המלאה תוצג במסכים קטנים יותר.
localizedAccountNameLabel

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

string

התווית של רמת ההטבות המשנית, למשל 'רמת הטבות'.
localizedSecondaryRewardsTierLabel

object (LocalizedString)

מחרוזות מתורגמות של secondaryRewardsTierLabel.
secondaryRewardsTier

string

דרגת ההטבות המשנית, למשל 'זהב' או 'פלטינה'.
localizedSecondaryRewardsTier

object (LocalizedString)

מחרוזות מתורגמות של secondaryRewardsTier.
discoverableProgram

object (DiscoverableProgram)

מידע על האופן שבו אפשר לגלות את הכיתה וליצור אותה מתוך אפליקציית Google Pay.
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 או 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 ואחד מהשדות ברמת האובייקט: smartTapRedemptionValue, barcode.value, oraccountId.
countryCode

string

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

object (Image)

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

object (Image)

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

boolean

האפשרות הזו קובעת אם הכיתה תומכת בהקשה חכמה. כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר בצורה נכונה גם את השדה redemptionIssuers ואת אחד מהשדות ברמת האובייקט: smartTapRedemptionLevel, barcode.value, or accountId.
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)

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

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

DiscoverableProgram

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

ייצוג ב-JSON 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
שדות
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

מידע על האפשרות להירשם לתוכנית הזו ולהוסיף לה נכס דיגיטלי שאפשר לממש דרך אתר של מוכר. משמש כשהאפשרות MERCHANT_HOSTED_SIGNUP מופעלת.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

מידע על היכולת להיכנס לחשבון ולהוסיף פריט בעל ערך לתוכנית הזו דרך אתר של מוכר. משמש כשהאפשרות MERCHANT_HOSTED_SIGNIN מופעלת.
state

enum (State)

מצב החשיפה של התוכנית שגלויה לכולם.

DiscoverableProgramMerchantSignupInfo

מידע על תהליך ההרשמה לתוכנית שמתארח באתר של המוכר.

ייצוג ב-JSON 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
שדות
signupWebsite

object (Uri)

כתובת ה-URL שאליה המשתמש יועבר לאתר ההרשמה של המוכר.
signupSharedDatas[]

enum (SharedDataType)

נתוני משתמשים שנשלחים בבקשת POST לכתובת ה-URL של אתר ההרשמה. המידע הזה מקודד ולאחר מכן משותף, כדי שאתר המוכר יוכל למלא מראש שדות שמשמשים להרשמה של המשתמש לתוכנית הגלויה.

SharedDataType

טיפוסים בני מנייה (enum)
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS שדה כתובת בשורה אחת
ADDRESS_LINE_1 שדות כתובת עם כמה שורות
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

מידע על תהליך הכניסה לאתר של מועדון לקוחות שמתארח אצל המוכר.

ייצוג ב-JSON 
{
  "signinWebsite": {
    object (Uri)
  }
}
שדות
signinWebsite

object (Uri)

כתובת ה-URL שאליה המשתמש יועבר לאתר הכניסה של המוכר.

מדינה

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED
TRUSTED_TESTERS מוצג רק לבודקים שיש להם גישה לחשבון המנפיק.
trustedTesters

כתובת אימייל חלופית מדור קודם של TRUSTED_TESTERS. הוצא משימוש.
LIVE גלוי לכולם.
live

כתובת אימייל חלופית מדור קודם של LIVE. הוצא משימוש.
DISABLED לא גלוי.
disabled

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

Methods

addmessage

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

get

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

insert

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

list

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

patch

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

update

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