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" .

program Name

string

مورد نیاز. نام برنامه، مانند "پوشاک آدم". ممکن است برنامه پس از 20 کاراکتر اول بیضی را نمایش دهد تا اطمینان حاصل شود که رشته کامل در صفحه های کوچکتر نمایش داده می شود.

account Name Label

string

برچسب نام حساب، مانند "نام عضو". حداکثر طول توصیه شده 15 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه نمایش های کوچکتر نمایش داده می شود.

account Id Label

string

برچسب شناسه حساب، مانند "شناسه عضو". حداکثر طول توصیه شده 15 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه نمایش های کوچکتر نمایش داده می شود.

rewards Tier Label

string

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

rewards Tier

string

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

localized Program Name

object ( LocalizedString )

رشته های ترجمه شده برای برنامهName. ممکن است برنامه پس از 20 کاراکتر اول بیضی را نمایش دهد تا اطمینان حاصل شود که رشته کامل در صفحه های کوچکتر نمایش داده می شود.

localized Account Name Label

object ( LocalizedString )

رشته های ترجمه شده برای accountNameLabel. حداکثر طول توصیه شده 15 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه نمایش های کوچکتر نمایش داده می شود.

localized Account Id Label

object ( LocalizedString )

رشته های ترجمه شده برای accountIdLabel. حداکثر طول توصیه شده 15 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه نمایش های کوچکتر نمایش داده می شود.

localized Rewards Tier Label

object ( LocalizedString )

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

localized Rewards Tier

object ( LocalizedString )

رشته های ترجمه شده برای rewardsTier. حداکثر طول توصیه شده 7 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه نمایش های کوچکتر نمایش داده می شود.

secondary Rewards Tier Label

string

برچسب ردیف جوایز ثانویه، مانند "رده پاداش".

localized Secondary Rewards Tier Label

object ( LocalizedString )

رشته های ترجمه شده برای secondaryRewardsTierLabel.

secondary Rewards Tier

string

ردیف جوایز ثانویه، مانند "طلا" یا "پلاتین".

localized Secondary Rewards Tier

object ( LocalizedString )

رشته های ترجمه شده برای secondaryRewardsTier.

discoverable Program

object ( DiscoverableProgram )

اطلاعاتی درباره نحوه کشف و نمونه‌سازی کلاس از داخل برنامه Google Pay.

class Template Info

object ( ClassTemplateInfo )

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

id

string

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

version
(deprecated)

string ( int64 format)

منسوخ شده است

issuer Name

string

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

messages[]

object ( Message )

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

allowMultipleUsersPerObject
(deprecated)

boolean

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

homepage Uri

object ( Uri )

URI صفحه اصلی برنامه شما. پر کردن URI در این فیلد دقیقاً همان رفتار پر کردن یک URI را در linksModuleData انجام می دهد (زمانی که یک شی رندر می شود، پیوندی به صفحه اصلی در قسمتی که معمولاً به عنوان بخش linksModuleData از شی در نظر گرفته می شود نشان داده می شود).

locations[]
(deprecated)

object ( LatLongPoint )

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

review Status

enum ( ReviewStatus )

مورد نیاز. وضعیت کلاس. با استفاده از درج، وصله یا به‌روزرسانی فراخوان‌های API، می‌توان این فیلد را روی draft یا underReview تنظیم کرد. هنگامی که وضعیت بررسی از draft تغییر کرد، نمی توان آن را به draft تغییر داد.

وقتی کلاس در حال توسعه است، باید این فیلد را برای draft نگه دارید. یک کلاس draft را نمی توان برای ایجاد هر شی استفاده کرد.

زمانی که فکر می کنید کلاس برای استفاده آماده است، باید این فیلد را روی underReview تنظیم کنید. پلتفرم به طور خودکار این فیلد را روی approved تنظیم می کند و می توان بلافاصله از آن برای ایجاد یا انتقال اشیا استفاده کرد.

هنگام به‌روزرسانی کلاسی که قبلاً approved ، باید این فیلد را روی underReview تنظیم کنید.

review

object ( Review )

نظرات مروری که توسط پلتفرم تنظیم می‌شوند، زمانی که یک کلاس approved یا rejected است.

infoModuleData
(deprecated)

object ( InfoModuleData )

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

image Modules Data[]

object ( ImageModuleData )

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

text Modules Data[]

object ( TextModuleData )

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

redemption Issuers[]

string ( int64 format)

مشخص می کند کدام صادرکنندگان بازخرید می توانند مجوز را از طریق Smart Tap بازخرید کنند. صادرکنندگان بازخرید با شناسه صادرکننده آنها شناسایی می شوند. صادرکنندگان بازخرید باید حداقل یک کلید Smart Tap پیکربندی شده باشند.

فیلدهای enableSmartTap و یکی از فیلدهای سطح شی smartTapRedemptionValue ، barcode.value , or accountId` نیز باید به درستی تنظیم شوند تا یک پاس از Smart Tap پشتیبانی کند.

country Code

string

کد کشوری که برای نمایش کشور کارت (زمانی که کاربر در آن کشور نیست) و همچنین برای نمایش محتوای بومی سازی شده زمانی که محتوا در منطقه کاربر در دسترس نیست، استفاده می شود.

hero Image

object ( Image )

تصویر بنر اختیاری در جلوی کارت نمایش داده می شود. اگر هیچ کدام وجود نداشته باشد، چیزی نمایش داده نمی شود. تصویر با عرض 100% نمایش داده می شود.

wordMark
(deprecated)

object ( Image )

منسوخ شده است.

enable Smart Tap

boolean

تشخیص می دهد که آیا این کلاس از Smart Tap پشتیبانی می کند یا خیر. فیلدهای redemptionIssuers و یکی از فیلدهای سطح شی smartTapRedemptionLevel ، barcode.value , or accountId` نیز باید به درستی تنظیم شوند تا مجوز از Smart Tap پشتیبانی کند.

hex Background Color

string

رنگ پس زمینه کارت اگر تنظیم نشده باشد از رنگ غالب تصویر قهرمان استفاده می شود و اگر تصویر قهرمان تنظیم نشده باشد از رنگ غالب لوگو استفاده می شود. قالب # rrggbb است که در آن rrggbb یک سه گانه RGB هگز است، مانند #ffcc00 . همچنین می توانید از نسخه کوتاه سه گانه RGB که # rgb است، مانند #fc0 استفاده کنید.

localized Issuer Name

object ( LocalizedString )

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

multiple Devices And Holders Allowed Status

enum ( MultipleDevicesAndHoldersAllowedStatus )

مشخص می کند که آیا چندین کاربر و دستگاه یک شیء مشابه را با ارجاع به این کلاس ذخیره می کنند یا خیر.

callback Options

object ( CallbackOptions )

گزینه‌های Callback برای فراخوانی مجدد صادرکننده برای هر ذخیره/حذف یک شی برای این کلاس توسط کاربر نهایی استفاده می‌شود. همه اشیاء این کلاس واجد شرایط بازگشت به تماس هستند.

security Animation

object ( SecurityAnimation )

اطلاعات اختیاری در مورد انیمیشن امنیتی. اگر این تنظیم باشد، یک انیمیشن امنیتی در جزئیات پاس نمایش داده می شود.

view Unlock Requirement

enum ( ViewUnlockRequirement )

گزینه های مورد نیاز باز کردن قفل را برای کارت وفاداری مشاهده کنید.

notify Preference

enum ( NotificationSettingsForUpdates )

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

value Added Module Data[]

object ( ValueAddedModuleData )

داده های ماژول ارزش افزوده اختیاری. حداکثر ده نفر در کلاس برای یک پاس فقط ده نمایش داده خواهد شد، با اولویت دادن به موارد موجود در شی.

برنامه قابل کشف

اطلاعاتی درباره نحوه کشف و نمونه‌سازی کلاس از داخل برنامه Android Pay. این کار با جستجوی برنامه وفاداری یا کارت هدیه و اسکن یا وارد کردن دستی انجام می شود.

نمایندگی JSON 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
فیلدها
merchant Signup Info

object ( DiscoverableProgramMerchantSignupInfo )

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

merchant Signin Info

object ( DiscoverableProgramMerchantSigninInfo )

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

state

enum ( State )

وضعیت دید برنامه قابل کشف

DiscoverableProgramMerchantSignupInfo

اطلاعاتی درباره جریان ثبت نام میزبان تاجر برای یک برنامه.

نمایندگی JSON 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
فیلدها
signup Website

object ( Uri )

URL برای هدایت کاربر برای سایت ثبت نام تاجر.

signup Shared Datas[]

enum ( SharedDataType )

داده های کاربر که در یک درخواست POST به URL وب سایت ثبت نام ارسال می شود. این اطلاعات کدگذاری شده و سپس به اشتراک گذاشته می‌شود تا وب‌سایت تاجر بتواند فیلدهایی را که برای ثبت نام کاربر برای برنامه قابل کشف استفاده می‌شود، از قبل پر کند.

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)
  }
}
فیلدها
signin Website

object ( Uri )

نشانی اینترنتی جهت هدایت کاربر به سایت ورود به سیستم تاجر.

ایالت

Enums
STATE_UNSPECIFIED
TRUSTED_TESTERS فقط برای آزمایش‌کنندگانی که به حساب صادرکننده دسترسی دارند قابل مشاهده است.
trustedTesters

نام مستعار قدیمی برای TRUSTED_TESTERS . منسوخ شده است.

LIVE قابل مشاهده برای همه
live

نام مستعار میراث برای LIVE . منسوخ شده است.

DISABLED قابل مشاهده نیست.
disabled

نام مستعار قدیمی برای DISABLED . منسوخ شده است.

روش ها

addmessage

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

get

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

insert

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

list

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

patch

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

update

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