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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
שדות
kind
(deprecated)

string

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

string

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

string

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

string

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

string

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

string

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

string

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

object (LocalizedString)

מחרוזות מתורגמות עבור תוכנית התגמולים המשנית של תוכנית התגמולים של Google Partners.
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 ב-linkModuleData (כשאובייקט עובר עיבוד, קישור לדף הבית מוצג באופן שבדרך כלל נחשב כ-LinkModuleData של האובייקט).
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)

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

גם השדה enableSmartTap ואחד מהשדות ברמת האובייקט smartTapRedemptionValue, ברקוד.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)

מחרוזות מתורגמות של המנפיק שם. האורך המקסימלי המומלץ הוא 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_ANSWER מופעל.
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

טיפוסים בני מנייה (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

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