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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
الحقول
kind
(deprecated)

string

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

string

مطلوب. اسم البرنامج، مثل "ملابس آدم". قد يعرض التطبيق علامة حذف بعد أول 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)

سلاسل مترجمة لمكافآتTierLabel يبلغ الحد الأقصى المقترَح للطول 9 أحرف لضمان عرض السلسلة الكاملة على الشاشات الأصغر حجمًا.
localizedRewardsTier

object (LocalizedString)

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

string

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

object (LocalizedString)

سلاسل مترجَمة لثانوية RewardsTierLabel
secondaryRewardsTier

string

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

object (LocalizedString)

سلاسل مترجمة لفئة ثانوية محدَّدة.
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)

معرّف الموارد المنتظم (URI) للصفحة الرئيسية للتطبيق. ينتج عن ملء عنوان URI في هذا الحقل السلوك نفسه الذي يؤدي إليه تعبئة عنوان URI في linksModuleData (عند عرض كائن، يظهر رابط إلى الصفحة الرئيسية فيما يُنظر إليه عادةً على أنّه قسم 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 وأحد الحقلَين smartTapRedemptionValue على مستوى العنصر "bar.value, oraccountId" بشكل صحيح لكي تكون البطاقة متوافقة مع "الدفع الذكي".
countryCode

string

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

object (Image)

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

object (Image)

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

boolean

تحدِّد ما إذا كانت هذه الفئة تتيح الدفع الذكي. يجب أيضًا إعداد الحقلَين redemptionIssuers وأحد الحقلَين smartTapRedemptionLevel على مستوى العنصر "bar.value, or accountId" بشكل صحيح لكي تكون البطاقة متوافقة مع "الدفع الذكي".
hexBackgroundColor

string

لون خلفية البطاقة إذا لم يتم تعيين اللون السائد لصورة الجزء الرئيسي، وإذا لم يتم تعيين صورة الجزء الرئيسي، فسيتم استخدام اللون السائد في الشعار. التنسيق هو رقم rrggbb، حيث يكون rrggbb عبارة عن ثلاثي بنموذج أحمر أخضر أزرق سداسي، مثل #ffcc00. يمكنك أيضًا استخدام النسخة المختصرة للنموذج الثلاثي أحمر أخضر أزرق، وهو رقم rgb، مثل #fc0.
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

تحدِّد هذه السياسة ما إذا كان العديد من المستخدمين والأجهزة سيحفظ العنصر نفسه الذي يشير إلى هذه الفئة.
callbackOptions

object (CallbackOptions)

خيارات معاودة الاتصال التي يمكن استخدامها لمعاودة الاتصال بجهة الإصدار عند كل عملية حفظ أو حذف لعنصر في هذه الفئة من قِبل المستخدم النهائي جميع عناصر هذا الفئة مؤهَّلة لمعاودة الاتصال.
securityAnimation

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

الاطّلاع على خيارات "متطلبات فتح القفل" الخاصة ببطاقة الولاء

DiscoverableProgram

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

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

object (DiscoverableProgramMerchantSignupInfo)

معلومات حول إمكانية الاشتراك في هذا البرنامج وإضافة قيمة إليه من خلال الموقع الإلكتروني للتاجر يتم استخدامه عندما يتم تفعيل MERCHANT_HOSTED_بورغ.
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

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