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

string

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

string

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

string

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

string

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

string

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

string

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

string

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

object (LocalizedString)

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

string

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

object (LocalizedString)

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

object (LatLongPoint)

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

enum (ReviewStatus)

חובה. הסטטוס של הכיתה. אפשר להגדיר את השדה הזה לערך 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 ואחת ברמת האובייקט smartTapRedemptionValue, brand.value, oraccountId' צריכים להיות מוגדרים בצורה נכונה.
countryCode

string

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

object (Image)

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

object (Image)

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

boolean

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

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

DiscoverableProgram

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

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

object (DiscoverableProgramMerchantSignupInfo)

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

SharedDataType

טיפוסים בני מנייה (enums)
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 שאליה המשתמש יופנה לאתר הכניסה של המוכר.

ארץ

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

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

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

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

שיטות

addmessage

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

get

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

insert

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

list

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

patch

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

update

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