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)
  }
}
الحقول
kind
(deprecated)

string

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

title

string

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

redemptionChannel

enum (RedemptionChannel)

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

provider

string

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

titleImage

object (Image)

تمثّل هذه السمة صورة عنوان العرض. يتم عرض هذه الصورة في كل من تفاصيل التطبيق وطريقة عرضه على شكل قائمة.

details

string

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

finePrint

string

النص المكتوب بخط دقيق أو بنود العرض، مثل "خصم% 20 على أي قميص في متجر سامر للملابس".

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)

عنوان URI للصفحة الرئيسية للتطبيق. تؤدي تعبئة معرّف الموارد المنتظم (URI) في هذا الحقل إلى اتباع نفس طريقة تعبئة URI في linkModuleData (عند عرض كائن، يظهر رابط إلى الصفحة الرئيسية في ما يُعرَف عادةً باسم قسم 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) وهو رقم rgb، مثل #fc0.

localizedIssuerName

object (LocalizedString)

سلاسل مُترجَمة لـ providerName الحد الأقصى المقترَح للطول هو 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

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