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

string

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

string

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

string

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

string

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

boolean

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

object (LocalizedString)

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

object (LocalizedString)

سلاسل مترجمة لـpinLabel.
localizedEventNumberLabel

object (LocalizedString)

السلاسل المترجمة للحدث eventNumberLabel.
cardNumberLabel

string

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

object (LocalizedString)

السلاسل المترجمة للبطاقة CardNumberLabel.
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 أو 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)

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

الطُرق

addmessage

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

get

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

insert

 يتم إدخال فئة بطاقة هدايا مع المعرّف والخصائص المقدَّمة.

list

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

patch

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

update

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