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)

מחרוזות מתורגמות עבור התגמולים המשניים של RewardsTierLabel.
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)

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

כדי שהכרטיס יתמוך בתכונה 'הקשה חכמה', צריך להגדיר גם את השדה enableSmartTap ואחד מהשדות ברמת האובייקט: smartTapRedemptionValue, barcode.value, oraccountId.
countryCode

string

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

object (Image)

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

object (Image)

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

boolean

מזהה אם הכיתה הזו תומכת בהקשה חכמה. גם השדה redemptionIssuers ואחד מהשדות ברמת האובייקט smartTapRedemptionLevel, ברקוד.value, or accountId` צריכים להיות מוגדרים כראוי כדי שכרטיס יתמוך בהקשה חכמה.
hexBackgroundColor

string

צבע הרקע של הכרטיס. אם לא מגדירים את הצבע הדומיננטי של התמונה הראשית (Hero), משתמשים בתמונה הראשית (Hero) אם לא הגדרתם את הצבע הדומיננטי של הלוגו. הפורמט הוא #rrggbb, כאשר rrggbb הוא שלשה הקסדצימלית של RGB, למשל #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)

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

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. הוצא משימוש.

שיטות

addmessage

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

get

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

insert

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

list

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

patch

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

update

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