REST Resource: loyaltyobject

المورد: loyaltyObject

تمثيل JSON 
{
  "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)
  }
}
الحقول
kind
(deprecated)

string

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

object (LoyaltyClass)

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

string

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

string

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

object (LoyaltyPoints)

تصنيف نقاط مكافأة الولاء والرصيد ونوعها.
linkedOfferIds[]

string

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

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

object (LoyaltyPoints)

تمثّل هذه السمة تصنيف نقاط مكافأة الولاء الثانوية والرصيد ونوعها. يظهر هذا الخيار بالإضافة إلى نقاط الولاء الأساسية.
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 فقط.

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

LoyaltyPoints

تمثيل JSON 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
الحقول
label

string

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

object (LoyaltyPointsBalance)

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

object (LocalizedString)

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

LoyaltyPointsBalance

تمثيل JSON 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
الحقول
string

string

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

integer

تمثّل هذه السمة صيغة العدد الصحيح للرصيد. يجب تعبئة نوع واحد فقط من هذه الأنواع الفرعية (سلسلة أو int أو مزدوج أو أموال).
double

number

تمثّل هذه السمة الطريقة المزدوجة للتوازن. يجب تعبئة نوع واحد فقط من هذه الأنواع الفرعية (سلسلة أو int أو مزدوج أو أموال).
money

object (Money)

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

الطُرق

addmessage

 يضيف هذا الزر رسالة إلى عنصر الولاء المشار إليه من خلال رقم تعريف العنصر المحدّد.

get

 لعرض كائن الولاء باستخدام رقم تعريف الكائن المحدد.

insert

 يدرج عنصر الولاء مع المعرّف والمواقع المحددة.

list

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

modifylinkedofferobjects

 يُعدّل عناصر العرض المرتبط لعنصر الولاء باستخدام المعرّف المحدّد.

patch

 تُعدِّل عنصر الولاء المشار إليه من خلال رقم تعريف العنصر المحدّد.

update

 تُعدِّل عنصر الولاء المشار إليه من خلال رقم تعريف العنصر المحدّد.