REST Resource: genericobject

منبع: GenericObject

شیء عمومی

نمایندگی JSON 
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
فیلدها
genericType

enum ( GenericType )

مشخص کنید که کارت به کدام GenericType تعلق دارد.

cardTitle

object ( LocalizedString )

مورد نیاز. سر پاس. این معمولاً نام تجاری مانند "XXX Gym"، "AAA Insurance" است. این فیلد الزامی است و در ردیف سرصفحه در بالای پاس ظاهر می شود.

subheader

object ( LocalizedString )

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

header

object ( LocalizedString )

مورد نیاز. عنوان پاس، مانند «کوپن تخفیف 50 درصدی» یا «کارت کتابخانه» یا «کوپن». این فیلد ضروری است و در ردیف عنوان نمای جزئیات پاس ظاهر می شود.

hexBackgroundColor

string

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

notifications

object ( Notifications )

تنظیمات اعلان که برای این شی فعال شده است.

id

string

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

classId

string

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

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

barcode

object ( Barcode )

نوع و مقدار بارکد اگر پاس دارای بارکد نباشد، می‌توانیم به صادرکننده اجازه دهیم Barcode.alternate_text را تنظیم کند و دقیقاً آن را نمایش دهد.

heroImage

object ( Image )

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

validTimeInterval

object ( TimeInterval )

دوره زمانی این شی معتبر یا قابل استفاده در نظر گرفته می شود. پس از گذشت مدت زمان، شی منقضی شده در نظر گرفته می شود که بر روی رندر دستگاه های کاربر تأثیر می گذارد.

imageModulesData[]

object ( ImageModuleData )

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

textModulesData[]

object ( TextModuleData )

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

groupingInfo

object ( GroupingInfo )

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

smartTapRedemptionValue

string

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

rotatingBarcode

object ( RotatingBarcode )

تنظیمات/جزئیات بارکد چرخشی

state

enum ( State )

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

hasUsers

boolean

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

passConstraints

object ( PassConstraints )

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

saveRestrictions

object ( SaveRestrictions )

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

GenericType

نوع کارت ژنریک

Enums
GENERIC_TYPE_UNSPECIFIED نوع عمومی نامشخص
GENERIC_SEASON_PASS پاس فصل
GENERIC_UTILITY_BILLS قبوض آب و برق
GENERIC_PARKING_PASS پاس پارکینگ
GENERIC_VOUCHER کوپن
GENERIC_GYM_MEMBERSHIP کارت عضویت در باشگاه
GENERIC_LIBRARY_MEMBERSHIP کارت عضویت کتابخانه
GENERIC_RESERVATIONS رزرواسیون
GENERIC_AUTO_INSURANCE کارت های بیمه خودرو
GENERIC_HOME_INSURANCE کارت های بیمه خانه
GENERIC_ENTRY_TICKET بلیط های ورودی
GENERIC_RECEIPT رسیدها
GENERIC_OTHER نوع دیگر

اطلاعیه ها

نشان می دهد که آیا شی باید اعلان را فعال کند یا خیر. ما فقط یکی از ExpiryNotification/UpcomingNotification را پشتیبانی می کنیم. expiryNotification بر upcomingNotification اولویت دارد. به عبارت دیگر، اگر expiryNotification تنظیم شده باشد، قسمت upcomingNotification را نادیده می گیریم.

نمایندگی JSON 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
فیلدها
expiryNotification

object ( ExpiryNotification )

یک اعلان در زمان خاصی قبل از انقضای کارت فعال می شود.

upcomingNotification

object ( UpcomingNotification )

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

ExpiryNotification

نشان می‌دهد که صادرکننده می‌خواهد Google Wallet 2 روز قبل از انقضای کارت اعلان‌های انقضا ارسال کند.

نمایندگی JSON 
{
  "enableNotification": boolean
}
فیلدها
enableNotification

boolean

نشان می دهد که آیا شی باید اعلان انقضا را فعال کند.

اطلاعیه آینده

نشان می‌دهد که صادرکننده می‌خواهد Google Wallet یک اعلان اعتبار کارت آینده را ۱ روز قبل از معتبر/قابل استفاده شدن کارت ارسال کند.

نمایندگی JSON 
{
  "enableNotification": boolean
}
فیلدها
enableNotification

boolean

نشان می دهد که آیا شی باید اعلان آینده را فعال کند یا خیر.

روش ها

addmessage

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

get

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

insert

 یک شیء عمومی با شناسه و خصوصیات داده شده را درج می کند.

list

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

patch

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

update

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