این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

REST Resource: offerclass

منبع: OfferClass
- نمایندگی JSON
- RedemptionChannel
روش ها

منبع: OfferClass

نمایندگی JSON

نمایندگی JSON
{ "kind": string, "title": string, "redemptionChannel": enum (`RedemptionChannel`), "provider": string, "titleImage": { object (`Image`) }, "details": string, "finePrint": string, "helpUri": { object (`Uri`) }, "localizedTitle": { object (`LocalizedString`) }, "localizedProvider": { object (`LocalizedString`) }, "localizedDetails": { object (`LocalizedString`) }, "localizedFinePrint": { object (`LocalizedString`) }, "shortTitle": string, "localizedShortTitle": { object (`LocalizedString`) }, "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`), "wideTitleImage": { object (`Image`) }, "notifyPreference": enum (`NotificationSettingsForUpdates`), "appLinkData": { object (`AppLinkData`) }, "valueAddedModuleData": [ { object (`ValueAddedModuleData`) } ] }

{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    object (LocalizedString)
  },
  "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),
  "wideTitleImage": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

فیلدها
`kind (deprecated)`	`string` این مورد منسوخ شده است! مشخص می کند که این چه نوع منبعی است. مقدار: رشته ثابت `"walletobjects#offerClass"` .
`title`	`string` مورد نیاز. عنوان پیشنهاد، مانند "20٪ تخفیف برای هر تی شرت." حداکثر طول توصیه شده 60 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه نمایش های کوچکتر نمایش داده می شود.
`redemption Channel`	`enum ( RedemptionChannel )` مورد نیاز. کانال‌های بازخرید مربوط به این پیشنهاد.
`provider`	`string` مورد نیاز. ارائه‌دهنده پیشنهاد (یا نام جمع‌آورنده یا نام تاجر). حداکثر طول توصیه شده 12 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه نمایش های کوچکتر نمایش داده می شود.
`title Image`	`object ( Image )` تصویر عنوان پیشنهاد. این تصویر هم در جزئیات و هم در نمای لیست برنامه نمایش داده می شود.
`details`	`string` جزئیات پیشنهاد.
`fine Print`	`string` چاپ دقیق یا شرایط پیشنهاد، مانند "20٪ تخفیف برای هر تی شرت در Adam's Apparel."
`help Uri`	`object ( Uri )` پیوند راهنمایی برای پیشنهاد، مانند `http://myownpersonaldomain.com/help`
`localized Title`	`object ( LocalizedString )` رشته های ترجمه شده برای عنوان. حداکثر طول توصیه شده 60 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه نمایش های کوچکتر نمایش داده می شود.
`localized Provider`	`object ( LocalizedString )` رشته های ترجمه شده برای ارائه دهنده. حداکثر طول توصیه شده 12 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه نمایش های کوچکتر نمایش داده می شود.
`localized Details`	`object ( LocalizedString )` رشته های ترجمه شده برای جزئیات.
`localized Fine Print`	`object ( LocalizedString )` رشته های ترجمه شده برای finePrint.
`short Title`	`string` نسخه کوتاه شده عنوان پیشنهاد، مانند "20٪ تخفیف"، به عنوان یک مرجع سریع به محتوای پیشنهاد به کاربران نشان داده می شود. حداکثر طول توصیه شده 20 کاراکتر است.
`localized Short Title`	`object ( LocalizedString )` رشته های ترجمه شده برای عنوان کوتاه. حداکثر طول توصیه شده 20 کاراکتر است.
`class Template Info`	`object ( ClassTemplateInfo )` اطلاعات الگو در مورد نحوه نمایش کلاس. اگر تنظیم نشود، Google به مجموعه ای از فیلدهای پیش فرض برای نمایش بازگشته است.
`id`	`string` مورد نیاز. شناسه منحصر به فرد برای یک کلاس. این شناسه باید در همه کلاس‌ها از یک صادرکننده منحصربه‌فرد باشد. این مقدار باید از `issuer ID` قالب پیروی کند. `identifier` جایی که اولی توسط Google صادر می شود و دومی توسط شما انتخاب می شود. شناسه منحصر به فرد شما باید فقط شامل کاراکترهای الفبایی، '.'، '_' یا '-' باشد.
`version (deprecated)`	`string ( int64 format)` این مورد منسوخ شده است! منسوخ شده است
`issuer Name`	`string` مورد نیاز. نام صادر کننده. حداکثر طول توصیه شده 20 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه های کوچکتر نمایش داده می شود.
`messages[]`	`object ( Message )` مجموعه ای از پیام ها در برنامه نمایش داده می شود. همه کاربران این شیء پیام های مرتبط با آن را دریافت خواهند کرد. حداکثر تعداد این فیلدها 10 عدد می باشد.
`allowMultipleUsersPerObject (deprecated)`	`boolean` این مورد منسوخ شده است! منسوخ شده است. به جای آن از `multipleDevicesAndHoldersAllowedStatus` استفاده کنید.
`homepage Uri`	`object ( Uri )` URI صفحه اصلی برنامه شما. پر کردن URI در این فیلد دقیقاً همان رفتار پر کردن یک URI را در linksModuleData انجام می دهد (زمانی که یک شی رندر می شود، پیوندی به صفحه اصلی در قسمتی که معمولاً به عنوان بخش linksModuleData از شی در نظر گرفته می شود نشان داده می شود).
`locations[] (deprecated)`	`object ( LatLongPoint )` این مورد منسوخ شده است! توجه: این فیلد در حال حاضر برای فعال کردن اعلان‌های جغرافیایی پشتیبانی نمی‌شود.
`review Status`	`enum ( ReviewStatus )` مورد نیاز. وضعیت کلاس. این فیلد را می توان روی `draft` یا وضعیت کلاس تنظیم کرد. با استفاده از درج، وصله یا به‌روزرسانی فراخوان‌های API، می‌توان این فیلد را روی `draft` یا `underReview` تنظیم کرد. هنگامی که وضعیت بررسی از `draft` تغییر کرد، نمی توان آن را به `draft` تغییر داد. وقتی کلاس در حال توسعه است، باید این فیلد را برای `draft` نگه دارید. یک کلاس `draft` را نمی توان برای ایجاد هر شی استفاده کرد. زمانی که فکر می کنید کلاس برای استفاده آماده است، باید این فیلد را روی `underReview` تنظیم کنید. پلتفرم به طور خودکار این فیلد را روی `approved` تنظیم می کند و می توان بلافاصله از آن برای ایجاد یا انتقال اشیا استفاده کرد. هنگام به‌روزرسانی کلاسی که قبلاً `approved` ، باید این فیلد را روی `underReview` تنظیم کنید.
`review`	`object ( Review )` نظرات مروری که توسط پلتفرم تنظیم می‌شوند، زمانی که یک کلاس `approved` یا `rejected` است.
`infoModuleData (deprecated)`	`object ( InfoModuleData )` این مورد منسوخ شده است! منسوخ شده است. به جای آن از textModulesData استفاده کنید.
`image Modules Data[]`	`object ( ImageModuleData )` داده های ماژول تصویر حداکثر تعداد این فیلدهای نمایش داده شده 1 از سطح شی و 1 برای سطح شیء کلاس است.
`text Modules Data[]`	`object ( TextModuleData )` داده های ماژول متنی اگر داده های ماژول متنی نیز روی کلاس تعریف شده باشد، هر دو نمایش داده می شوند. حداکثر تعداد این فیلدهای نمایش داده شده 10 از شی و 10 از کلاس است.
`links Module Data`	`object ( LinksModuleData )` داده های ماژول را پیوند می دهد. اگر داده های ماژول پیوندها نیز روی شی تعریف شده باشد، هر دو نمایش داده می شوند.
`redemption Issuers[]`	`string ( int64 format)` مشخص می کند کدام صادرکنندگان بازخرید می توانند مجوز را از طریق Smart Tap بازخرید کنند. صادرکنندگان بازخرید با شناسه صادرکننده آنها شناسایی می شوند. صادرکنندگان بازخرید باید حداقل یک کلید Smart Tap پیکربندی شده باشند. فیلدهای `enableSmartTap` و سطح شیء `smartTapRedemptionLevel` نیز باید به درستی تنظیم شوند تا پاس از Smart Tap پشتیبانی کند.
`country Code`	`string` کد کشوری که برای نمایش کشور کارت (زمانی که کاربر در آن کشور نیست) و همچنین برای نمایش محتوای بومی سازی شده زمانی که محتوا در منطقه کاربر در دسترس نیست، استفاده می شود.
`hero Image`	`object ( Image )` تصویر بنر اختیاری در جلوی کارت نمایش داده می شود. اگر هیچ کدام وجود نداشته باشد، چیزی نمایش داده نمی شود. تصویر با عرض 100% نمایش داده می شود.
`wordMark (deprecated)`	`object ( Image )` این مورد منسوخ شده است! منسوخ شده است.
`enable Smart Tap`	`boolean` تشخیص می دهد که آیا این کلاس از Smart Tap پشتیبانی می کند یا خیر. فیلدهای `redemptionIssuers` و سطح شیء `smartTapRedemptionLevel` نیز باید به درستی تنظیم شوند تا مجوز از Smart Tap پشتیبانی کند.
`hex Background Color`	`string` رنگ پس زمینه کارت اگر تنظیم نشده باشد از رنگ غالب تصویر قهرمان استفاده می شود و اگر تصویر قهرمان تنظیم نشده باشد از رنگ غالب لوگو استفاده می شود. قالب # `rrggbb` است که در آن `rrggbb` یک سه گانه RGB هگز است، مانند `#ffcc00` . همچنین می توانید از نسخه کوتاه سه گانه RGB که # `rgb` است، مانند `#fc0` استفاده کنید.
`localized Issuer Name`	`object ( LocalizedString )` رشته های ترجمه شده برای صادرکنندهName. حداکثر طول توصیه شده 20 کاراکتر است تا اطمینان حاصل شود که رشته کامل در صفحه های کوچکتر نمایش داده می شود.
`multiple Devices And Holders Allowed Status`	`enum ( MultipleDevicesAndHoldersAllowedStatus )` مشخص می کند که آیا چندین کاربر و دستگاه یک شیء مشابه را با ارجاع به این کلاس ذخیره می کنند یا خیر.
`callback Options`	`object ( CallbackOptions )` گزینه‌های Callback برای فراخوانی مجدد صادرکننده برای هر ذخیره/حذف یک شی برای این کلاس توسط کاربر نهایی استفاده می‌شود. همه اشیاء این کلاس واجد شرایط بازگشت به تماس هستند.
`security Animation`	`object ( SecurityAnimation )` اطلاعات اختیاری در مورد انیمیشن امنیتی. اگر این تنظیم باشد، یک انیمیشن امنیتی در جزئیات پاس نمایش داده می شود.
`view Unlock Requirement`	`enum ( ViewUnlockRequirement )` گزینه های مورد نیاز باز کردن قفل را برای پیشنهاد مشاهده کنید.
`wide Title Image`	`object ( Image )` تصویر عریض عنوان پیشنهاد. در صورت ارائه، به جای تصویر عنوان در سمت چپ بالای نمای کارت استفاده می شود.
`notify Preference`	`enum ( NotificationSettingsForUpdates )` اینکه آیا به‌روزرسانی‌های فیلد این کلاس باید اعلان‌ها را راه‌اندازی کند یا خیر. وقتی روی NOTIFY تنظیم شود، سعی می کنیم یک اعلان به روز رسانی فیلد را برای کاربران فعال کنیم. این اعلان‌ها تنها در صورتی برای کاربران ارسال می‌شوند که این قسمت بخشی از یک لیست مجاز باشد. اگر مشخص نشده باشد، هیچ اعلانی فعال نخواهد شد. این تنظیم زودگذر است و باید با هر درخواست PATCH یا UPDATE تنظیم شود، در غیر این صورت اعلانی راه اندازی نمی شود.
`app Link Data`	`object ( AppLinkData )` پیوند برنامه یا وب سایت اختیاری که به عنوان یک دکمه در جلوی پاس نمایش داده می شود. اگر AppLinkData برای شیء مربوطه که به جای آن استفاده می شود ارائه شده باشد.
`value Added Module Data[]`	`object ( ValueAddedModuleData )` داده های ماژول ارزش افزوده اختیاری. حداکثر ده نفر در کلاس برای یک پاس فقط ده نمایش داده خواهد شد، با اولویت دادن به موارد موجود در شی.

RedemptionChannel

Enums
`REDEMPTION_CHANNEL_UNSPECIFIED`
`INSTORE`
`instore`	نام مستعار قدیمی برای `INSTORE` . منسوخ شده است. این مورد منسوخ شده است!
`ONLINE`
`online`	نام مستعار قدیمی برای `ONLINE` . منسوخ شده است. این مورد منسوخ شده است!
`BOTH`
`both`	نام مستعار میراث برای `BOTH` . منسوخ شده است. این مورد منسوخ شده است!
`TEMPORARY_PRICE_REDUCTION`
`temporaryPriceReduction`	نام مستعار قدیمی برای `TEMPORARY_PRICE_REDUCTION` . منسوخ شده است. این مورد منسوخ شده است!

روش ها
`addmessage`	یک پیام به کلاس پیشنهادی که توسط شناسه کلاس داده شده ارجاع داده شده است اضافه می کند.
`get`	کلاس پیشنهادی را با شناسه کلاس داده شده برمی گرداند.
`insert`	یک کلاس پیشنهادی با شناسه و ویژگی های داده شده درج می کند.
`list`	فهرستی از تمام کلاس‌های پیشنهادی برای شناسه صادرکننده معین را برمی‌گرداند.
`patch`	کلاس پیشنهادی که توسط شناسه کلاس مشخص شده ارجاع داده شده است را به روز می کند.
`update`	کلاس پیشنهادی که توسط شناسه کلاس مشخص شده ارجاع داده شده است را به روز می کند.

REST Resource: offerclass

منبع: OfferClass

RedemptionChannel

روش ها

`addmessage`

`get`

`insert`

`list`

`patch`

`update`