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

القيمة التي سيتم إرسالها إلى محطة دفع معتمَدة من خلال تكنولوجيا "الدفع الذكي" عبر 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

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

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

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

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

الطُرق

addmessage

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

get

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

insert

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

list

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

patch

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

update

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