REST Resource: giftcardclass

المورد: GiftCardClass

تمثيل JSON 
{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    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),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
الحقول
kind
(deprecated)

string

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

string

اسم التاجر، مثل "Adam's Apparel" قد يعرض التطبيق علامة شرطة منقطة بعد أول 20 حرفًا لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
pinLabel

string

التصنيف الذي سيتم عرضه لرقم التعريف الشخصي، مثل "رقم تعريف شخصي مكوّن من 4 أرقام"
eventNumberLabel

string

التصنيف الذي سيتم عرضه لرقم الحدث، مثل "رقم الحدث المستهدَف".
allowBarcodeRedemption

boolean

يحدِّد ما إذا كان التاجر يتيح تحصيل قيمة بطاقة الهدايا باستخدام الرمز الشريطي. إذا كانت القيمة هي true، يعرض التطبيق رمزًا شريطيًا لبطاقة الهدايا على شاشة "تفاصيل بطاقة الهدايا". إذا كان القيمة خطأ، لن يتم عرض رمز شريطي.
localizedMerchantName

object (LocalizedString)

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

object (LocalizedString)

السلاسل النصية المترجَمة لعنصر pinLabel
localizedEventNumberLabel

object (LocalizedString)

سلاسل مُترجَمة لعنصر eventNumberLabel
cardNumberLabel

string

التصنيف الذي سيتم عرضه لرقم البطاقة، مثل "رقم البطاقة"
localizedCardNumberLabel

object (LocalizedString)

سلاسل النصوص المترجَمة لبطاقة الرقم التعريفي
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 أو 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 مجموعة سداسية عشرية من قيم RGB، مثل #ffcc00. يمكنك أيضًا استخدام الرمز المختصر للثلاثي RGB وهو #rgb، مثل #fc0.
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

اطّلِع على خيارات متطلبات فتح بطاقة الهدايا.
notifyPreference

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

الطُرق

addmessage

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

get

 تعرِض هذه الدالة فئة بطاقة الهدايا باستخدام معرّف الفئة المحدّد.

insert

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

list

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

patch

 تعديل فئة بطاقة الهدايا المُشار إليها بمعرّف الفئة المحدّد

update

 تعديل فئة بطاقة الهدايا المُشار إليها بمعرّف الفئة المحدّد