REST Resource: giftcardobject

المورد: GiftCardObject

تمثيل JSON 
{
  "kind": string,
  "classReference": {
    object (GiftCardClass)
  },
  "cardNumber": string,
  "pin": string,
  "balance": {
    object (Money)
  },
  "balanceUpdateTime": {
    object (DateTime)
  },
  "eventNumber": string,
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
الحقول
kind
(deprecated)

string

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

object (GiftCardClass)

نسخة من الحقول المكتسَبة من الفئة الرئيسية يتم استرداد هذه الحقول أثناء عملية GET.
cardNumber

string

مطلوب. رقم البطاقة
pin

string

رقم التعريف الشخصي للبطاقة.
balance

object (Money)

الرصيد النقدي للبطاقة
balanceUpdateTime

object (DateTime)

تاريخ ووقت آخر تعديل للرصيد.

الإزاحة مطلوبة.

إذا تم تعديل الرصيد ولم يتم تقديم هذه السمة، سيستخدم النظام الوقت الحالي تلقائيًا.
eventNumber

string

رقم الحدث للبطاقة، وهو حقل اختياري تستخدمه بعض بطاقات الهدايا.
id

string

مطلوب. تمثّل هذه السمة المعرّف الفريد للعنصر. ويجب أن يكون هذا المعرّف فريدًا في كل العناصر من جهة الإصدار. يجب أن تتبع هذه القيمة التنسيق issuer ID.identifier حيث يتم إصدار الطريقة السابقة من قِبل Google واختيار الطريقة الثانية من قِبلك. يجب أن يتضمّن المعرّف الفريد أحرفًا أبجدية رقمية فقط، مثل "." أو "_" أو "-".
classId

string

مطلوب. الفئة المرتبطة بهذا العنصر. يجب أن تكون الفئة من نوع هذا العنصر نفسه، ويجب أن تكون متوفّرة من قبل، ويجب أن تتم الموافقة عليها.

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

string (int64 format)

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

enum (State)

مطلوب. حالة العنصر يُستخدَم هذا الحقل لتحديد كيفية عرض عنصر في التطبيق. على سبيل المثال، يتم نقل عنصر inactive إلى قسم "البطاقات المنتهية الصلاحية". .
barcode

object (Barcode)

نوع الرمز الشريطي وقيمته
messages[]

object (Message)

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

object (TimeInterval)

الفترة الزمنية التي سيكون هذا الكائن فيها active ويمكن استخدام الكائن. سيتم تغيير حالة العنصر إلى expired عند انقضاء هذه الفترة الزمنية.
locations[]

object (LatLongPoint)

ملاحظة: هذا الحقل غير متاح حاليًا لتشغيل الإشعارات الجغرافية.
hasUsers

boolean

يشير إلى ما إذا كان العنصر يحتوي على مستخدمين. تضبط المنصة هذا الحقل.
smartTapRedemptionValue

string

القيمة التي سيتم إرسالها إلى محطة دفع معتمَدة من خلال تكنولوجيا "الدفع الذكي" عبر NFC لهذا الجهاز يجب أيضًا إعداد حقلَي مستوى الصف enableSmartTap وredemptionIssuers بشكل صحيح لكي تتمكّن البطاقة من استخدام "الدفع الذكي". يُسمح باستخدام أحرف ASCII فقط.
hasLinkedDevice

boolean

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

boolean

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

في الوقت الحالي، لا يمكن ضبط هذا الإعداد إلا للعروض.
infoModuleData

object (InfoModuleData)

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

object (ImageModuleData)

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

object (TextModuleData)

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

object (RotatingBarcode)

نوع الرمز الشريطي الدوار وقيمته
heroImage

object (Image)

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

object (GroupingInfo)

المعلومات التي تتحكّم في كيفية تجميع البطاقات معًا
passConstraints

object (PassConstraints)

قيود التمرير للكائن. ويشمل ذلك الحدّ من سلوكيات تقنية NFC ولقطات الشاشة.
saveRestrictions

object (SaveRestrictions)

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

الطُرق

addmessage

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

get

 لعرض عنصر بطاقة الهدايا برقم تعريف العنصر المحدّد.

insert

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

list

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

patch

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

update

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