REST Resource: offerobject

المرجع: OfferObject

تمثيل JSON 
{
  "kind": string,
  "classReference": {
    object (OfferClass)
  },
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
الحقول
kind
(deprecated)

string

لتحديد نوع المورد. القيمة: السلسلة الثابتة "walletobjects#offerObject".
classReference

object (OfferClass)

نسخة من الحقول المكتسَبة من الفئة الرئيسية يتم استرداد هذه الحقول أثناء طلب GET.
id

string

مطلوب. المعرّف الفريد للعنصر يجب أن يكون هذا المعرّف فريدًا في جميع العناصر الصادرة عن جهة إصدار. يجب أن تكون هذه القيمة بالتنسيق issuer ID.identifier حيث يتم إصدار الأول من Google ويتم اختيار الثاني من قِبلك. يجب أن يتضمّن المعرّف الفريد أحرفًا أبجدية رقمية فقط أو النقطة أو الشرطة السفلية أو الواصلة.
classId

string

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

يجب أن تتّبع أرقام تعريف الصفوف التنسيق issuer ID.identifier حيث يتم إصدار الأول من Google ويتم اختيار الثاني من قِبلك.
version
(deprecated)

string (int64 format)

منهي العمل به
state

enum (State)

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

object (Barcode)

نوع الرمز الشريطي وقيمته
messages[]

object (Message)

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

object (TimeInterval)

الفترة الزمنية التي سيكون فيها هذا الكائن active ويمكن استخدام الكائن. سيتم تغيير حالة العنصر إلى expired بعد انقضاء هذه الفترة الزمنية.
locations[]

object (LatLongPoint)

ملاحظة: لا يمكن حاليًا استخدام هذا الحقل لتشغيل الإشعارات الجغرافية.
hasUsers

boolean

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

string

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

boolean

ما إذا كان هذا العنصر مرتبطًا حاليًا بجهاز واحد يضبط النظام الأساسي هذا الحقل عندما يحفظ المستخدم العنصر ويربطه بجهازه. مخصّص للاستخدام من قِبل شركاء محدّدين. يُرجى التواصل مع فريق الدعم للحصول على معلومات إضافية.
disableExpirationNotification

boolean

يشير إلى ما إذا كان يجب إيقاف الإشعارات صراحةً. في حال ضبط هذا الحقل على "صحيح"، سيتم حظر إرسال إشعارات انتهاء الصلاحية إلى المستخدم بغض النظر عن حقل messages. يتم ضبط هذا الحقل تلقائيًا على false.

لا يمكن حاليًا ضبط هذه القيمة إلا للعروض.
infoModuleData

object (InfoModuleData)

تمّ الإيقاف. استخدِم textModulesData بدلاً من ذلك.
imageModulesData[]

object (ImageModuleData)

بيانات وحدة الصور الحد الأقصى لعدد هذه الحقول المعروضة هو حقل واحد من مستوى الكائن وحقل واحد من مستوى كائن الفئة.
textModulesData[]

object (TextModuleData)

بيانات وحدة النصوص إذا تمّ أيضًا تحديد بيانات وحدة النص في الفئة، سيتم عرض كليهما. الحد الأقصى لعدد هذه الحقول المعروضة هو 10 من العنصر و10 من الفئة.
rotatingBarcode

object (RotatingBarcode)

نوع الرمز الشريطي المتغيّر وقيمته
heroImage

object (Image)

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

object (GroupingInfo)

المعلومات التي تتحكّم في كيفية تجميع البطاقات معًا
passConstraints

object (PassConstraints)

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

object (SaveRestrictions)

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

string

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

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

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

enum (NotificationSettingsForUpdates)

ما إذا كان يجب أن تؤدي تعديلات الحقل على هذا العنصر إلى إرسال إشعارات أم لا عند ضبط القيمة على NOTIFY (إشعار)، سنحاول إرسال إشعار إلى المستخدمين بشأن تعديل الحقل. ولن يتم إرسال هذه الإشعارات إلى المستخدمين إلا إذا كان الحقل جزءًا من قائمة مسموح بها. في حال ضبط القيمة على DO_NOT_NOTIFY أو NOTIFICATION_SETTINGS_UNSPECIFIED، لن يتم تشغيل أي إشعار. هذا الإعداد مؤقت ويجب ضبطه مع كل طلب PATCH أو UPDATE، وإلا لن يتم تشغيل إشعار.
valueAddedModuleData[]

object (ValueAddedModuleData)

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

الطُرق

addmessage

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

get

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

insert

 تُدرج عنصر عرض باستخدام المعرّف والسمات المحدّدة.

list

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

patch

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

update

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