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)
  }
}
الحقول
kind
(deprecated)

string

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

programName

string

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

accountNameLabel

string

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

accountIdLabel

string

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

rewardsTierLabel

string

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

rewardsTier

string

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

localizedProgramName

object (LocalizedString)

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

localizedAccountNameLabel

object (LocalizedString)

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

localizedAccountIdLabel

object (LocalizedString)

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

localizedRewardsTierLabel

object (LocalizedString)

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

localizedRewardsTier

object (LocalizedString)

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

secondaryRewardsTierLabel

string

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

localizedSecondaryRewardsTierLabel

object (LocalizedString)

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

secondaryRewardsTier

string

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

localizedSecondaryRewardsTier

object (LocalizedString)

سلاسل النصوص المترجَمة في برنامج RewardssTier الثانوي

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 في linkModuleData (عند عرض كائن، يظهر رابط إلى الصفحة الرئيسية في ما يُعرَف عادةً باسم قسم 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 على مستوى العنصر، وهو الرمز الشريطي "قيمة", oraccountId` بشكل صحيح كي تتيح البطاقة "الدفع الذكي".

countryCode

string

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

heroImage

object (Image)

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

wordMark
(deprecated)

object (Image)

تمّ الإيقاف.

enableSmartTap

boolean

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

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

سلاسل مُترجَمة لـ providerName الحد الأقصى المقترَح للطول هو 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_CONVERSATION.

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

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