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,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}
الحقول
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 حيث يتم إصدار 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

القيمة التي سيتم إرسالها إلى محطة دفع معتمَدة من Smart Tap عبر NFC لهذا العنصر. يجب أيضًا إعداد حقلَي مستوى الصف enableSmartTap وredemptionIssuers بشكل صحيح لكي تكون البطاقة متوافقة مع ميزة "الدفع الذكي". لا يمكن استخدام سوى أحرف ASCII.
rotatingBarcode

object (RotatingBarcode)

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

enum (State)

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

boolean

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

object (Message)

صفيف من الرسائل المعروضة في التطبيق. سيتلقّى جميع مستخدمي هذا العنصر الرسائل المرتبطة به. الحد الأقصى لعدد هذه الحقول هو 10.
passConstraints

object (PassConstraints)

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

object (SaveRestrictions)

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

object (ValueAddedModuleData)

بيانات اختيارية لمكوّنات القيمة المضافة عشرة عناصر كحد أقصى على الجسم
linkedObjectIds[]

string

تمثل ‎linkedObjectIds قائمة بعناصر أخرى، مثل تذكرة حضور الحدث وبطاقة الولاء والعرض الترويجي والعنصر العام وبطاقة الهدايا وبطاقة النقل العام وبطاقة صعود الطائرة، والتي يجب إرفاقها تلقائيًا بهذا العنصر العام. إذا كان المستخدم قد حفظ هذه البطاقة العامة، سيتم إرسال أرقام تعريف العناصر المرتبطة هذه تلقائيًا إلى محفظة المستخدم (ما لم يوقف خيار تلقّي هذه البطاقات المرتبطة).

تأكَّد من أنّه سبق إدراج العناصر المتوفّرة في linkedObjectIds، وإلا ستتعذّر عمليات الاستدعاء. بعد ربط العناصر، لا يمكن إلغاء ربطها. لا يمكنك ربط عناصر تابعة لمُصدِر آخر. هناك حدّ أقصى لعدد العناصر التي يمكن ربطها بعنصر واحد. بعد بلوغ الحدّ الأقصى، سيتم تجاهل الكائنات المرتبطة الجديدة في المكالمة بدون إشعار.

يجب أن تتبع أرقام تعريف الكائنات التنسيق issuer ID.identifier حيث تُصدر Google المعرّف الأول ويكون المعرّف الثاني من اختيارك.

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_LOYALTY_CARD بطاقات الولاء يُرجى العلم أنّه من المستحسن استخدام نوع بطاقة ولاء مخصّص بدلاً من هذا النوع العام. يوفّر نوع البطاقة المخصّص لبطاقة الولاء ميزات ووظائف أكثر من نوع البطاقة العام.
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

 تعديل العنصر العام المُشار إليه بمعرّف العنصر المحدّد