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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
الحقول
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)

سلاسل مترجمة لـ firePrint.
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)

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

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)

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

object (TextModuleData)

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

string (int64 format)

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

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

string

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

object (Image)

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

object (Image)

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

boolean

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

string

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

object (LocalizedString)

سلاسل مترجمة لـ publisherName يبلغ الحد الأقصى المقترَح للطول 20 حرفًا لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

الاطّلاع على خيارات "متطلبات فتح القفل" الخاصة بالعرض
wideTitleImage

object (Image)

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

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

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