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

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

object (RotatingBarcode)

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

enum (State)

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

boolean

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

object (PassConstraints)

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

object (SaveRestrictions)

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

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/PendingNotification. تكون الأولوية للدالة 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

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