REST Resource: genericclass

منبع: GenericClass

کلاس عمومی

نمایندگی JSON
{
  "id": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "enableSmartTap": boolean,
  "redemptionIssuers": [
    string
  ],
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "messages": [
    {
      object (Message)
    }
  ],
  "appLinkData": {
    object (AppLinkData)
  }
}
فیلدها
id

string

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

classTemplateInfo

object ( ClassTemplateInfo )

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

imageModulesData[]

object ( ImageModuleData )

داده های ماژول تصویر اگر imageModulesData نیز روی شی تعریف شده باشد، هر دو نمایش داده می شوند. زمانی که هر دو تنظیم شوند، تنها یکی از تصویرهای کلاس و یکی از سطح شیء ارائه می شود.

textModulesData[]

object ( TextModuleData )

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

enableSmartTap

boolean

فقط برای شرکای فعال Smart Tap در دسترس است. برای راهنمایی بیشتر با پشتیبانی تماس بگیرید.

redemptionIssuers[]

string ( int64 format)

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

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

securityAnimation

object ( SecurityAnimation )

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

multipleDevicesAndHoldersAllowedStatus

enum ( MultipleDevicesAndHoldersAllowedStatus )

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

callbackOptions

object ( CallbackOptions )

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

viewUnlockRequirement

enum ( ViewUnlockRequirement )

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

messages[]

object ( Message )

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

روش ها

addmessage

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

get

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

insert

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

list

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

patch

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

update

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