REST Resource: genericobject

المورد: GenericObject

معرّف العنصر التالي العام: 121

تمثيل 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)
  }
}
الحقول
genericType

enum (GenericType)

يجب تحديد GenericType التي تنتمي إليها البطاقة.
cardTitle

object (LocalizedString)

مطلوبة. عنوان البطاقة. ويكون عادةً اسم النشاط التجاري، مثل "XXX Gym" أو "AAA Insurance". هذا الحقل مطلوب ويظهر في صف العنوان في أعلى البطاقة.
subheader

object (LocalizedString)

تصنيف عنوان البطاقة، مثل الموقع الجغرافي الذي يمكن استخدامها فيه تظهر أعلى العنوان مباشرةً في صف العنوان في عرض تفاصيل البطاقة.
header

object (LocalizedString)

مطلوبة. عنوان البطاقة، مثل "قسيمة خصم% 50" أو "بطاقة المكتبة" أو "قسيمة" هذا الحقل مطلوب ويظهر في صف العنوان في عرض تفاصيل البطاقة.
hexBackgroundColor

string

لون خلفية البطاقة إذا لم يتم تعيين، يتم استخدام اللون السائد لصورة الجزء الرئيسي، وإذا لم يتم تعيين صورة الجزء الرئيسي، يتم استخدام اللون السائد للشعار وإذا لم يتم تعيين الشعار، فستختار Google اللون.
notifications

object (Notifications)

إعدادات الإشعارات التي تم تفعيلها لهذا العنصر
id

string

مطلوبة. المعرّف الفريد لأحد العناصر. ويجب أن يكون هذا المعرّف فريدًا على مستوى كل العناصر التي تقدّمها جهة الإصدار. يجب أن تتّبع هذه القيمة التنسيق issuerID.identifier الذي تصدر فيه Google السمة issuerID وتختار أنت identifier. لا يمكن أن يتضمّن المعرّف الفريد سوى أحرف أبجدية رقمية أو . أو _ أو -.
classId

string

مطلوبة. الفئة المرتبطة بهذا الكائن. ويجب أن تكون الفئة من نوع هذا الكائن نفسه، وأن تكون موجودة بالفعل، وأن تتم الموافقة عليها.

يجب أن تكون معرّفات الصفوف بالتنسيق issuerID.identifier الذي تصدر فيه Google السمة issuerID وتختار 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 لهذا العنصر ويجب أيضًا إعداد الحقلَين enableSmartTap وredemptionIssuers على مستوى الصف بشكل صحيح لإتاحة استخدام "الدفع الذكي" في البطاقة. يمكن استخدام أحرف ASCII فقط.
rotatingBarcode

object (RotatingBarcode)

إعدادات/تفاصيل الرمز الشريطي الدوّار
state

enum (State)

حالة العنصر يُستخدَم هذا الحقل لتحديد طريقة عرض عنصر في التطبيق. على سبيل المثال، يتم نقل عنصر inactive إلى قسم "البطاقات المنتهية الصلاحية". وإذا لم يتم توفير هذه السمة، سيتم اعتبار العنصر ACTIVE.
hasUsers

boolean

يشير إلى ما إذا كان العنصر يحتوي على مستخدمين. يتم تعيين هذا الحقل بواسطة النظام الأساسي.
passConstraints

object (PassConstraints)

تمرير قيود العنصر يشمل ذلك الحدّ من استخدام تقنية NFC ولقطات الشاشة.

GenericType

نوع البطاقة العامة.

عمليات التعداد
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/SentNotification. يكون للقاعدة expiryNotification الأولوية على upcomingNotification. أو بعبارةٍ أخرى، في حال ضبط expiryNotification، سنتجاهل الحقل upcomingNotification.

تمثيل JSON 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
الحقول
expiryNotification

object (ExpiryNotification)

سيظهر إشعار في وقت محدد قبل انتهاء صلاحية البطاقة.
upcomingNotification

object (UpcomingNotification)

وسيظهر إشعار في الوقت المحدّد قبل أن تصبح البطاقة قابلة للاستخدام.

ExpiryNotification

يشير هذا الرمز إلى أنّ جهة إصدار البطاقة تريد من "محفظة Google" إرسال إشعارات انتهاء صلاحية قبل يومَين من تاريخ انتهاء صلاحية البطاقة.

تمثيل JSON 
{
  "enableNotification": boolean
}
الحقول
enableNotification

boolean

يشير هذا العمود إلى ما إذا كان يجب تفعيل إشعار انتهاء الصلاحية في العنصر.

UpcomingNotification

يشير هذا الرمز إلى أنّ جهة الإصدار تريد من "محفظة Google" إرسال إشعار قادم بشأن صلاحية البطاقة قبل يوم واحد من أن تصبح البطاقة صالحة/قابلة للاستخدام.

تمثيل JSON 
{
  "enableNotification": boolean
}
الحقول
enableNotification

boolean

يشير هذا العمود إلى ما إذا كان يجب تفعيل الإشعارات القادمة على العنصر.

الطُرق

addmessage

 تتم إضافة رسالة إلى العنصر العام الذي يشير إليه رقم تعريف العنصر المحدّد.

get

 لعرض الكائن العام برقم تعريف الكائن المحدّد.

insert

 لإدراج كائن عام برقم التعريف والخصائص المحددة.

list

 تعرض قائمة بكل العناصر العامة لرقم تعريف جهة إصدار معيّن.

patch

 يعدِّل العنصر العام المشار إليه من خلال رقم تعريف العنصر المحدّد.

update

 يعدِّل العنصر العام المشار إليه من خلال رقم تعريف العنصر المحدّد.