REST Resource: loyaltyobject

منبع: LoyaltyObject

نمایندگی JSON 
{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
فیلدها
kind
(deprecated)

string

مشخص می کند که این چه نوع منبعی است. مقدار: رشته ثابت "walletobjects#loyaltyObject" .

class Reference

object ( LoyaltyClass )

یک کپی از فیلدهای ارثی کلاس والد. این فیلدها در طول GET بازیابی می شوند.

account Name

string

نام دارنده حساب وفاداری، مانند «جان اسمیت». حداکثر طول توصیه شده 20 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه های کوچکتر نمایش داده می شود.

account Id

string

شناسه حساب وفاداری حداکثر طول توصیه شده 20 کاراکتر است.

loyalty Points

object ( LoyaltyPoints )

برچسب، تعادل و نوع امتیاز پاداش وفاداری.

linked Offer Ids[]

string

فهرستی از اشیاء پیشنهادی مرتبط با این کارت وفاداری. اشیاء پیشنهاد باید از قبل وجود داشته باشد.

شناسه‌های شی پیشنهاد باید از issuer ID قالب پیروی کنند. identifier جایی که اولی توسط Google صادر می شود و دومی توسط شما انتخاب می شود.

secondary Loyalty Points

object ( LoyaltyPoints )

برچسب، تعادل و نوع امتیاز پاداش وفاداری ثانویه. علاوه بر امتیازهای وفاداری اولیه نشان داده شده است.

id

string

مورد نیاز. شناسه منحصر به فرد برای یک شی. این شناسه باید در همه اشیاء صادرکننده منحصر به فرد باشد. این مقدار باید از issuer ID قالب پیروی کند. identifier جایی که اولی توسط Google صادر می شود و دومی توسط شما انتخاب می شود. شناسه منحصر به فرد باید فقط شامل کاراکترهای الفبای عددی، '.'، '_' یا '-' باشد.

class Id

string

مورد نیاز. کلاس مرتبط با این شی. کلاس باید از همان نوع این شی باشد، باید از قبل وجود داشته باشد و باید تایید شود.

شناسه‌های کلاس باید از فرمت issuer ID پیروی کنند. identifier جایی که اولی توسط Google صادر می شود و دومی توسط شما انتخاب می شود.

version
(deprecated)

string ( int64 format)

منسوخ شده است

state

enum ( State )

مورد نیاز. وضعیت جسم. این فیلد برای تعیین نحوه نمایش یک شی در برنامه استفاده می شود. به عنوان مثال، یک شی inactive به بخش "گذرنامه های منقضی" منتقل می شود.

barcode

object ( Barcode )

نوع و مقدار بارکد

messages[]

object ( Message )

مجموعه ای از پیام ها در برنامه نمایش داده می شود. همه کاربران این شیء پیام های مرتبط با آن را دریافت خواهند کرد. حداکثر تعداد این فیلدها 10 عدد می باشد.

valid Time Interval

object ( TimeInterval )

مدت زمانی که این شی active خواهد بود و می توان از شی استفاده کرد. پس از سپری شدن این بازه زمانی، وضعیت یک شی به expired تغییر می کند.

locations[]
(deprecated)

object ( LatLongPoint )

توجه: این فیلد در حال حاضر برای فعال کردن اعلان‌های جغرافیایی پشتیبانی نمی‌شود.

has Users

boolean

نشان می دهد که آیا شیء کاربر دارد یا خیر. این فیلد توسط پلتفرم تنظیم شده است.

smart Tap Redemption Value

string

مقداری که برای این شیء از طریق NFC به پایانه تأیید شده Smart Tap منتقل می شود. فیلدهای سطح کلاس enableSmartTap و redemptionIssuers نیز باید به درستی تنظیم شوند تا پاس از Smart Tap پشتیبانی کند. فقط کاراکترهای ASCII پشتیبانی می شوند.

اگر این مقدار تنظیم نشده باشد، اما فیلدهای سطح کلاس enableSmartTap و redemptionIssuers به ​​درستی تنظیم شده باشند، در صورت وجود، از barcode.value یا فیلدهای accountId به عنوان بازگشت استفاده می شود.

has Linked Device

boolean

آیا این شی در حال حاضر به یک دستگاه مرتبط است یا خیر. این فیلد زمانی توسط پلتفرم تنظیم می شود که کاربر شی را ذخیره می کند و آن را به دستگاه خود پیوند می دهد. برای استفاده توسط شرکای منتخب در نظر گرفته شده است. برای اطلاعات بیشتر با پشتیبانی تماس بگیرید.

disable Expiration Notification

boolean

نشان می دهد که آیا اعلان ها باید صریحاً سرکوب شوند یا خیر. اگر این فیلد روی درست تنظیم شود، صرف نظر از فیلد messages ، اعلان‌های انقضا به کاربر سرکوب می‌شوند. به طور پیش فرض، این فیلد روی false تنظیم شده است.

در حال حاضر، این فقط برای پیشنهادات قابل تنظیم است.

info Module Data

object ( InfoModuleData )

منسوخ شده است. به جای آن از textModulesData استفاده کنید.

image Modules Data[]

object ( ImageModuleData )

داده های ماژول تصویر حداکثر تعداد این فیلدهای نمایش داده شده 1 از سطح شی و 1 برای سطح شیء کلاس است.

text Modules Data[]

object ( TextModuleData )

داده های ماژول متنی اگر داده های ماژول متنی نیز روی کلاس تعریف شده باشد، هر دو نمایش داده می شوند. حداکثر تعداد این فیلدهای نمایش داده شده 10 از شی و 10 از کلاس است.

rotating Barcode

object ( RotatingBarcode )

نوع و مقدار بارکد چرخشی

hero Image

object ( Image )

تصویر بنر اختیاری در جلوی کارت نمایش داده می شود. اگر هیچ کدام وجود نداشته باشد، تصویر قهرمان کلاس، در صورت وجود، نمایش داده می شود. اگر تصویر قهرمان کلاس نیز وجود نداشته باشد، چیزی نمایش داده نخواهد شد.

grouping Info

object ( GroupingInfo )

اطلاعاتی که نحوه گروه بندی پاس ها را کنترل می کند.

pass Constraints

object ( PassConstraints )

تصویب محدودیت برای شی. شامل محدود کردن NFC و رفتارهای اسکرین شات است.

save Restrictions

object ( SaveRestrictions )

محدودیت‌هایی در مورد شیئی که باید قبل از اینکه کاربر تلاش کند پاس را ذخیره کند تأیید شود. توجه داشته باشید که این محدودیت فقط در زمان صرفه جویی اعمال خواهد شد. اگر پس از ذخیره گذرنامه توسط کاربر، محدودیت‌ها تغییر کردند، محدودیت‌های جدید برای مجوز ذخیره‌شده قبلی اعمال نمی‌شوند.

linked Object Ids[]

string

linkedObjectIds لیستی از اشیاء دیگر مانند بلیط رویداد، وفاداری، پیشنهاد، عمومی، کارت هدیه، حمل و نقل و کارت پرواز هستند که باید به طور خودکار به این شیء وفاداری متصل شوند. اگر کاربر این کارت وفاداری را ذخیره کرده باشد، این linkedObjectIds به طور خودکار به کیف پول کاربر منتقل می‌شوند (مگر اینکه تنظیمات دریافت چنین مجوزهای پیوندی را خاموش کرده باشند).

مطمئن شوید که اشیاء موجود در linkedObjectIds قبلاً درج شده اند - در غیر این صورت، تماس ها ناموفق خواهند بود. پس از پیوند، اشیاء پیوند شده را نمی توان لغو پیوند کرد. شما نمی توانید اشیاء متعلق به صادرکننده دیگری را پیوند دهید. محدودیتی برای تعداد اشیایی وجود دارد که می توان به یک شیء متصل کرد. پس از رسیدن به حد مجاز، اشیاء پیوند شده جدید در تماس بی‌صدا نادیده گرفته می‌شوند.

شناسه‌های شیء باید از issuer ID قالب پیروی کنند. identifier جایی که اولی توسط Google صادر می شود و دومی توسط شما انتخاب می شود.

notify Preference

enum ( NotificationSettingsForUpdates )

اینکه آیا به‌روزرسانی‌های فیلد برای این شی باید اعلان‌ها را راه‌اندازی کند یا خیر. وقتی روی NOTIFY تنظیم شود، سعی می کنیم یک اعلان به روز رسانی فیلد را برای کاربران فعال کنیم. این اعلان‌ها تنها در صورتی برای کاربران ارسال می‌شوند که این قسمت بخشی از یک لیست مجاز باشد. اگر روی DO_NOT_NOTIFY یا NOTIFICATION_SETTINGS_UNSPECIFIED تنظیم شود، هیچ اعلانی فعال نخواهد شد. این تنظیم زودگذر است و باید با هر درخواست PATCH یا UPDATE تنظیم شود، در غیر این صورت اعلانی راه اندازی نمی شود.

value Added Module Data[]

object ( ValueAddedModuleData )

داده های ماژول ارزش افزوده اختیاری. حداکثر ده روی جسم.

امتیازات وفاداری

نمایندگی JSON 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
فیلدها
label

string

برچسب امتیازات وفاداری، مانند "امتیاز". حداکثر طول پیشنهادی 9 کاراکتر است.

balance

object ( LoyaltyPointsBalance )

موجودی امتیاز وفاداری صاحب حساب، مانند "500" یا "10.00 دلار". حداکثر طول توصیه شده 7 کاراکتر است. این یک فیلد الزامی از loyaltyPoints و secondaryLoyaltyPoints است.

localized Label

object ( LocalizedString )

رشته های ترجمه شده برای برچسب. حداکثر طول پیشنهادی 9 کاراکتر است.

وفاداری امتیازات تعادل

نمایندگی JSON 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
فیلدها
string

string

شکل رشته ای تعادل. فقط یکی از این زیرگروه ها (string, int, double, money) باید پر شود.

int

integer

شکل عدد صحیح تعادل. فقط یکی از این زیرگروه ها (string, int, double, money) باید پر شود.

double

number

شکل دوگانه تعادل. فقط یکی از این زیرگروه ها (string, int, double, money) باید پر شود.

money

object ( Money )

شکل پولی تعادل. فقط یکی از این زیرگروه ها (string, int, double, money) باید پر شود.

روش ها

addmessage

 یک پیام به شیء وفاداری که توسط شناسه شی داده شده ارجاع داده شده است اضافه می کند.

get

 شیء وفاداری را با شناسه شی داده شده برمی گرداند.

insert

 یک شیء وفاداری را با شناسه و ویژگی های داده شده درج می کند.

list

 فهرستی از همه اشیاء وفاداری برای شناسه صادرکننده معین را برمی گرداند.

modifylinkedofferobjects

 اشیاء پیشنهاد پیوند شده را برای شیء وفاداری با شناسه داده شده اصلاح می کند.

patch

 شیء وفاداری ارجاع شده توسط شناسه شی داده شده را به روز می کند.

update

 شیء وفاداری ارجاع شده توسط شناسه شی داده شده را به روز می کند.