REST Resource: loyaltyobject

{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "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)
  }
}

string

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

object (LoyaltyClass)

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

string

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

string

معرّف حساب الولاء. الحد الأقصى الموصى به للطول هو 20 حرفًا.

object (LoyaltyPoints)

تصنيف نقاط مكافآت الولاء ورصيدها ونوعها

string

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

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

object (LoyaltyPoints)

تصنيف نقاط الولاء الثانوية ورصيدها ونوعها تظهر بالإضافة إلى نقاط الولاء الأساسية.

string

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

string

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

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

string (int64 format)

منهي العمل به

enum (State)

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

object (Barcode)

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

object (Message)

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

object (TimeInterval)

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

object (LatLongPoint)

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

boolean

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

string

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

في حال ترك هذه القيمة بدون ضبط، ولكن تم إعداد حقلَي مستوى الفئة enableSmartTap وredemptionIssuers بشكل صحيح، يتم استخدام الحقلَين barcode.value أو accountId كحقلَين احتياطيَين في حال توفُّرهما.

boolean

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

boolean

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

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

object (InfoModuleData)

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

object (ImageModuleData)

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

object (TextModuleData)

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

object (LinksModuleData)

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

object (AppLinkData)

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

object (RotatingBarcode)

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

object (Image)

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

object (GroupingInfo)

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

object (PassConstraints)

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

object (SaveRestrictions)

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

{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}

string

تصنيف نقاط الولاء، مثل "النقاط" الحد الأقصى الموصى به للطول هو 9 أحرف.

object (LoyaltyPointsBalance)

رصيد نقاط الولاء لصاحب الحساب، مثل "500" أو "10.00 دولار". الحد الأقصى الموصى به للطول هو 7 أحرف. هذا الحقل مطلوب لكل من loyaltyPoints وsecondaryLoyaltyPoints.

object (LocalizedString)

سلاسل مترجمة للتصنيف. الحد الأقصى الموصى به للطول هو 9 أحرف.

{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}

string

شكل السلسلة للرصيد. يجب تعبئة نوع واحد فقط من هذه الأنواع الفرعية (string, int, مزدوج، المال).

integer

صورة عدد صحيح للتوازن يجب تعبئة نوع واحد فقط من هذه الأنواع الفرعية (string, int, مزدوج، المال).

number

النموذج المزدوج للتوازن. يجب تعبئة نوع واحد فقط من هذه الأنواع الفرعية (string, int, مزدوج، المال).

object (Money)

الشكل المالي للرصيد. يجب تعبئة نوع واحد فقط من هذه الأنواع الفرعية (string, int, مزدوج، المال).