REST Resource: offerclass

المرجع: OfferClass

تمثيل JSON 
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideTitleImage": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
الحقول
kind
(deprecated)

string

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

string

مطلوب. عنوان العرض، مثل "خصم% 20 على أيّ قميص قصير الأكمام" الحد الأقصى المقترَح هو 60 حرفًا لضمان عرض السلسلة بالكامل على الشاشات الأصغر حجمًا.
redemptionChannel

enum (RedemptionChannel)

مطلوب. قنوات تحصيل القيمة السارية على هذا العرض.
provider

string

مطلوب. مقدّم العرض (إما اسم المجمّع أو اسم التاجر) الحد الأقصى المقترَح هو 12 حرفًا لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
titleImage

object (Image)

صورة عنوان العرض يتم عرض هذه الصورة في كل من طريقة عرض التفاصيل وقائمة التطبيقات.
details

string

تفاصيل العرض.
finePrint

string

التفاصيل الدقيقة أو أحكام العرض، مثل "خصم% 20 على أيّ قميص في Adam's Apparel"
helpUri

object (Uri)

رابط المساعدة الخاص بالعرض، مثل http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

سلاسل مترجمة للعنوان الحد الأقصى المقترَح هو 60 حرفًا لضمان عرض السلسلة بالكامل على الشاشات الأصغر حجمًا.
localizedProvider

object (LocalizedString)

سلاسل النصوص المترجَمة لموفّر الخدمة الحد الأقصى المقترَح هو 12 حرفًا لضمان عرض السلسلة بالكامل على الشاشات الأصغر حجمًا.
localizedDetails

object (LocalizedString)

سلاسل النصوص المترجَمة للتفاصيل
localizedFinePrint

object (LocalizedString)

السلاسل النصية المترجَمة للأحكام الدقيقة
shortTitle

string

نسخة مختصرة من عنوان العرض، مثل "خصم% 20"، يتم عرضها للمستخدمين كمرجع سريع لمحتوى العرض. الحد الأقصى المقترَح هو 20 حرفًا.
localizedShortTitle

object (LocalizedString)

سلاسل الترجمة للعنوان القصير الحد الأقصى المقترَح للطول هو 20 حرفًا.
classTemplateInfo

object (ClassTemplateInfo)

تمثّل هذه السمة معلومات النموذج حول الطريقة التي يجب عرض بها الصف. وفي حال عدم ضبطها، ستستعين Google بمجموعة تلقائية من الحقول لعرضها.
id

string

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

string (int64 format)

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

string

مطلوب. اسم جهة الإصدار الحد الأقصى المقترَح هو 20 حرفًا لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
messages[]

object (Message)

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

boolean

تمّ الإيقاف. استخدِم multipleDevicesAndHoldersAllowedStatus بدلاً من ذلك.
homepageUri

object (Uri)

معرّف الموارد المنتظم للصفحة الرئيسية لتطبيقك. يؤدي ملء معرّف الموارد المنتظم في هذا الحقل إلى السلوك نفسه تمامًا الذي يؤدي إليه ملء معرّف الموارد المنتظم في linksModuleData (عند عرض عنصر، يظهر رابط إلى الصفحة الرئيسية في ما يُعتقد عادةً أنّه قسم linksModuleData من العنصر).
locations[]
(deprecated)

object (LatLongPoint)

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

enum (ReviewStatus)

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

يجب إبقاء هذا الحقل في draft عندما يكون الصف قيد التطوير. لا يمكن استخدام الفئة draft لإنشاء أي كائن.

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

عند تعديل فئة approved، يجب مواصلة ضبط هذا الحقل على underReview.
review

object (Review)

تعليقات المراجعة التي تحدّدها المنصة عند وضع علامة approved أو rejected على الصف
infoModuleData
(deprecated)

object (InfoModuleData)

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

object (ImageModuleData)

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

object (TextModuleData)

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

string (int64 format)

يحدّد جهات إصدار البطاقة التي يمكن تحصيل قيمتها من خلال "الدفع الذكي". يتم تحديد جهات إصدار عمليات تحصيل القيمة من خلال رقم تعريف جهة الإصدار. يجب أن يكون لدى جهات إصدار الرموز المميّزة مفتاح Smart Tap واحدًا على الأقل تم ضبطه.

يجب أيضًا إعداد الحقلَين enableSmartTap وsmartTapRedemptionLevel على مستوى العنصر بشكل صحيح لكي تتيح البطاقة ميزة "النقرة الذكية".
countryCode

string

رمز البلد المستخدم لعرض بلد البطاقة (عندما لا يكون المستخدم مقيمًا في ذلك البلد)، بالإضافة إلى عرض محتوى مترجَم عندما لا يكون المحتوى متاحًا بلغة المستخدم.
heroImage

object (Image)

صورة بانر اختيارية تظهر على الجهة الأمامية من البطاقة وفي حال عدم توفّرها، لن يتم عرض أي شيء. سيتم عرض الصورة بعرض ‎100%.
wordMark
(deprecated)

object (Image)

تمّ الإيقاف.
enableSmartTap

boolean

لتحديد ما إذا كانت هذه الفئة تتيح ميزة "النقرة الذكية". يجب أيضًا إعداد الحقلَين redemptionIssuers وsmartTapRedemptionLevel على مستوى العنصر بشكل صحيح لكي تتيح البطاقة ميزة "النقرة الذكية".
hexBackgroundColor

string

لون خلفية البطاقة. إذا لم يتم ضبطه، يتم استخدام اللون السائد لصورة العرض، وإذا لم يتم ضبط صورة عرض، يتم استخدام اللون السائد للشعار. التنسيق هو رقم rrggbb، حيث يكون rrggbb عبارة عن ثلاثي بنموذج أحمر أخضر أزرق سداسي، مثل #ffcc00. يمكنك أيضًا استخدام النسخة المختصرة من مجموعة RGB الثلاثية وهي #rgb، مثل #fc0.
localizedIssuerName

object (LocalizedString)

سلاسل مُترجَمة لسمة issuerName الحد الأقصى المقترَح هو 20 حرفًا لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

تحدِّد هذه السياسة ما إذا كان العديد من المستخدمين والأجهزة سيحفظ العنصر نفسه الذي يشير إلى هذه الفئة.
callbackOptions

object (CallbackOptions)

خيارات طلب معاودة الاتصال التي سيتم استخدامها للاتصال بالمُصدِر عند كل حفظ أو حذف عنصر من هذا النوع من قِبل المستخدم النهائي. جميع عناصر هذه الفئة مؤهَّلة للاتصال الخلفي.
securityAnimation

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

اطّلِع على خيارات متطلبات فتح الجهاز للاستفادة من العرض.
wideTitleImage

object (Image)

صورة العنوان العريضة للعرض عند توفّرها، سيتم استخدامها بدلاً من صورة العنوان في أعلى يمين عرض البطاقة.
notifyPreference

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

بيانات اختيارية لمكوّنات القيمة المضافة عشرة طلاب كحد أقصى في الصف بالنسبة إلى البطاقة رقم 10 فقط، يتم عرض رقم البطاقة مع إعطاء الأولوية للبطاقة الواردة في العنصر.

RedemptionChannel

عمليات التعداد
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

اسم بديل قديم لـ INSTORE تمّ الإيقاف.
ONLINE
online

اسم بديل قديم لـ ONLINE تمّ الإيقاف.
BOTH
both

الاسم المستعار القديم لـ BOTH. تمّ الإيقاف.
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

الاسم المستعار القديم لـ TEMPORARY_PRICE_REDUCTION. تمّ الإيقاف.

الطُرق

addmessage

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

get

 لعرض فئة العرض التي تحمل رقم تعريف الفئة المحدّد.

insert

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

list

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

patch

 تعديل فئة العرض التي يشير إليها معرّف الفئة المحدّد

update

 تعديل فئة العرض التي يشير إليها معرّف الفئة المحدّد