REST Resource: loyaltyclass

المرجع: LoyaltyClass

تمثيل JSON 
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "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#loyaltyClass".
programName

string

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

string

تصنيف اسم الحساب، مثل "اسم العضو" الحد الأقصى المقترَح هو 15 حرفًا لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
accountIdLabel

string

تصنيف رقم تعريف الحساب، مثل "رقم تعريف المشترك" الحد الأقصى المقترَح هو 15 حرفًا لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
rewardsTierLabel

string

تصنيف مستوى المكافآت، مثل "مستوى المكافآت" الحد الأقصى المقترَح هو 9 أحرف لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
rewardsTier

string

فئة المكافآت، مثل "الذهبي" أو "البلاتيني" الحد الأقصى المقترَح هو 7 أحرف لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
localizedProgramName

object (LocalizedString)

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

object (LocalizedString)

سلاسل النصوص المترجَمة لسمة accountNameLabel الحد الأقصى المقترَح هو 15 حرفًا لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
localizedAccountIdLabel

object (LocalizedString)

سلاسل النصوص المترجَمة لسمة accountIdLabel الحد الأقصى المقترَح هو 15 حرفًا لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
localizedRewardsTierLabel

object (LocalizedString)

سلاسل أحرف مترجَمة لعنصر rewardsTierLabel الحد الأقصى المقترَح هو 9 أحرف لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
localizedRewardsTier

object (LocalizedString)

سلاسل نصية مترجَمة لرتبة_المكافآت الحد الأقصى المقترَح هو 7 أحرف لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
secondaryRewardsTierLabel

string

تصنيف مستوى المكافآت الثانوية، مثل "مستوى المكافآت"
localizedSecondaryRewardsTierLabel

object (LocalizedString)

سلاسل النصوص المترجَمة لـ secondaryRewardsTierLabel
secondaryRewardsTier

string

مستوى المكافآت الثانوية، مثل "الذهبي" أو "البلاتيني"
localizedSecondaryRewardsTier

object (LocalizedString)

سلاسل النصوص المترجَمة لـ secondaryRewardsTier
discoverableProgram

object (DiscoverableProgram)

معلومات عن كيفية اكتشاف الفئة وإنشاء مثيل لها من داخل تطبيق Google Pay
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 وأحد الحقلين smartTapRedemptionValue وbarcode.value, oraccountId على مستوى العنصر بشكل صحيح لكي تتيح البطاقة استخدام ميزة "النقرة الذكية".
countryCode

string

رمز البلد المستخدَم لعرض بلد البطاقة (عندما لا يكون المستخدم في ذلك البلد)، بالإضافة إلى عرض المحتوى المترجَم عندما لا يتوفّر المحتوى بلغة المستخدم
heroImage

object (Image)

صورة بانر اختيارية تظهر على واجهة البطاقة وفي حال عدم توفّر أي منها، لن يتم عرض أي شيء. سيتم عرض الصورة بعرض ‎100%.
wordMark
(deprecated)

object (Image)

تمّ الإيقاف.
enableSmartTap

boolean

لتحديد ما إذا كانت هذه الفئة تتيح ميزة "النقرة الذكية". يجب أيضًا إعداد الحقل redemptionIssuers وأحد الحقلين smartTapRedemptionLevel وbarcode.value, or accountId على مستوى العنصر بشكل صحيح لكي تتيح البطاقة استخدام ميزة "النقرة الذكية".
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)

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

DiscoverableProgram

معلومات عن كيفية اكتشاف فئة وإنشاء مثيل لها من داخل تطبيق Android Pay. ويتم ذلك من خلال البحث عن برنامج ولاء أو بطاقة هدايا ومسح ضوئي أو إدخالها يدويًا.

تمثيل JSON 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
الحقول
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

معلومات عن إمكانية الاشتراك في هذا البرنامج وإضافة قيمة له من خلال موقع تاجر إلكتروني يُستخدَم هذا المَعلمة عندما يكون MERCHANT_HOSTED_SIGNUP مفعَّلاً.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

معلومات عن إمكانية تسجيل الدخول وإضافة قيمة لهذا البرنامج من خلال موقع تاجر يُستخدَم هذا المَعلمة عندما يكون MERCHANT_HOSTED_SIGNIN مفعَّلاً.
state

enum (State)

حالة ظهور البرنامج القابل للاكتشاف

DiscoverableProgramMerchantSignupInfo

معلومات حول خطوات الاشتراك التي يستضيفها التاجر في أحد البرامج

تمثيل JSON 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
الحقول
signupWebsite

object (Uri)

عنوان URL لتوجيه المستخدم إلى موقع الاشتراك الخاص بالتاجر.
signupSharedDatas[]

enum (SharedDataType)

بيانات المستخدم التي يتم إرسالها في طلب POST إلى عنوان URL للموقع الإلكتروني للاشتراك ويتم ترميز هذه المعلومات ثم مشاركتها حتى يتمكّن موقع التاجر الإلكتروني من ملء الحقول المستخدَمة لتسجيل المستخدم في البرنامج القابل للاكتشاف مسبقًا.

SharedDataType

عمليات التعداد
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS حقل عنوان سطر واحد
ADDRESS_LINE_1 حقول العناوين متعددة الأسطر
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

معلومات حول مسار تسجيل الدخول الذي يستضيفه التاجر لبرنامج معيّن

تمثيل JSON 
{
  "signinWebsite": {
    object (Uri)
  }
}
الحقول
signinWebsite

object (Uri)

عنوان URL لتوجيه المستخدم إلى موقع تسجيل الدخول الخاص بالتاجر.

الحالة

عمليات التعداد
STATE_UNSPECIFIED
TRUSTED_TESTERS لا تظهر هذه القيمة إلا للمختبِرين الذين يمكنهم الوصول إلى حساب المُصدِر.
trustedTesters

اسم بديل قديم لـ TRUSTED_TESTERS تمّ الإيقاف.
LIVE مرئية للجميع
live

اسم بديل قديم لـ LIVE تمّ الإيقاف.
DISABLED غير مرئي
disabled

اسم بديل قديم لـ DISABLED تمّ الإيقاف.

الطُرق

addmessage

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

get

 لعرض فئة الولاء التي تحمل رقم تعريف الفئة المحدّد.

insert

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

list

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

patch

 تعديل فئة الولاء التي يشير إليها رقم تعريف الفئة المحدّد

update

 تعديل فئة الولاء التي يشير إليها رقم تعريف الفئة المحدّد