REST Resource: offerclass

แหล่งข้อมูล: OfferClass

การแสดง 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
(deprecated)

string

ระบุประเภทของทรัพยากร ค่า: สตริงคงที่ "walletobjects#offerClass"
title

string

ต้องระบุ ชื่อของข้อเสนอ เช่น "ลด 20% สำหรับเสื้อยืดทุกตัว" ความยาวสูงสุดที่แนะนำคือ 60 อักขระเพื่อให้สตริงแสดงเต็มในหน้าจอขนาดเล็ก
redemptionChannel

enum (RedemptionChannel)

ต้องระบุ ช่องทางแลกสิทธิ์ที่ใช้ได้กับข้อเสนอนี้
provider

string

ต้องระบุ ผู้ให้บริการข้อเสนอ (ชื่อผู้รวบรวมข้อมูลหรือชื่อผู้ขาย) ความยาวสูงสุดที่แนะนำคือ 12 อักขระเพื่อให้สตริงแสดงเต็มรูปแบบบนหน้าจอขนาดเล็ก
titleImage

object (Image)

รูปภาพชื่อของข้อเสนอ รูปภาพนี้จะแสดงทั้งในมุมมองรายละเอียดและมุมมองรายการของแอป
details

string

รายละเอียดของข้อเสนอ
finePrint

string

รายละเอียดปลีกย่อยหรือข้อกำหนดของข้อเสนอ เช่น "เสื้อยืดทุกตัวที่ Adam's Apparel ลด 20%"
helpUri

object (Uri)

ลิงก์ความช่วยเหลือสำหรับข้อเสนอ เช่น http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

สตริงที่แปลแล้วสำหรับชื่อ ความยาวสูงสุดที่แนะนำคือ 60 อักขระเพื่อให้แน่ใจว่าสตริงจะแสดงเต็มรูปแบบบนหน้าจอขนาดเล็ก
localizedProvider

object (LocalizedString)

สตริงที่แปลแล้วสำหรับผู้ให้บริการ ความยาวสูงสุดที่แนะนำคือ 12 อักขระเพื่อให้สตริงแสดงเต็มรูปแบบบนหน้าจอขนาดเล็ก
localizedDetails

object (LocalizedString)

สตริงที่แปลแล้วสำหรับรายละเอียด
localizedFinePrint

object (LocalizedString)

สตริงที่แปลแล้วสำหรับข้อกำหนดและเงื่อนไข
shortTitle

string

ชื่อข้อเสนอเวอร์ชันย่อ เช่น "ลด 20%" ที่แสดงต่อผู้ใช้เพื่อเป็นข้อมูลอ้างอิงสั้นๆ เกี่ยวกับเนื้อหาข้อเสนอ ความยาวสูงสุดที่แนะนำคือ 20 อักขระ
localizedShortTitle

object (LocalizedString)

สตริงที่แปลแล้วสำหรับชื่อย่อ ความยาวสูงสุดที่แนะนำคือ 20 อักขระ
classTemplateInfo

object (ClassTemplateInfo)

ข้อมูลเทมเพลตเกี่ยวกับวิธีแสดงชั้นเรียน หากไม่ได้ตั้งค่าไว้ Google จะแสดงชุดช่องเริ่มต้น
id

string

ต้องระบุ ตัวระบุที่ไม่ซ้ำกันสำหรับชั้นเรียน รหัสนี้ต้องไม่ซ้ำกันในทุกชั้นเรียนจากผู้ออกบัตร ค่านี้ควรเป็นไปตามรูปแบบ issuer IDidentifier โดยที่รหัสแรกจะออกโดย Google และรหัสหลังจะเลือกโดยคุณ ตัวระบุที่ไม่ซ้ำกันควรประกอบด้วยอักขระที่เป็นตัวอักษรและตัวเลขคละกัน, '.', '_' หรือ "-" เท่านั้น
version
(deprecated)

string (int64 format)

เลิกใช้
issuerName

string

ต้องระบุ ชื่อผู้ออกบัตร ความยาวสูงสุดที่แนะนำคือ 20 อักขระเพื่อให้สตริงแสดงเต็มรูปแบบบนหน้าจอขนาดเล็ก
messages[]

object (Message)

อาร์เรย์ข้อความที่แสดงในแอป ผู้ใช้ทั้งหมดของออบเจ็กต์นี้จะได้รับข้อความที่เกี่ยวข้อง จํานวนสูงสุดของช่องเหล่านี้คือ 10 ช่อง
allowMultipleUsersPerObject
(deprecated)

boolean

เลิกใช้งานแล้ว ให้ใช้ multipleDevicesAndHoldersAllowedStatus แทน
homepageUri

object (Uri)

URI ของหน้าแรกของแอปพลิเคชัน การป้อนข้อมูล URI ในช่องนี้จะทําให้มีลักษณะการทำงานเหมือนกับการป้อนข้อมูล URI ใน linksModuleData (เมื่อแสดงผลออบเจ็กต์ ลิงก์ไปยังหน้าแรกจะแสดงในส่วนที่มักเรียกว่าส่วน linksModuleData ของออบเจ็กต์)
locations[]
(deprecated)

object (LatLongPoint)

หมายเหตุ: ปัจจุบันระบบยังไม่รองรับการใช้ฟิลด์นี้เพื่อทริกเกอร์การแจ้งเตือนตามภูมิศาสตร์
reviewStatus

enum (ReviewStatus)

ต้องระบุ สถานะของชั้นเรียน ช่องนี้สามารถตั้งค่าเป็น draft หรือสถานะของชั้นเรียน ช่องนี้สามารถตั้งค่าเป็น draft หรือ underReview โดยใช้การเรียก API ของแทรก แก้ไข หรืออัปเดต เมื่อสถานะการตรวจสอบเปลี่ยนจาก 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)

ข้อมูลโมดูลข้อความ หากมีการกําหนดข้อมูลโมดูลข้อความในคลาสด้วย ระบบจะแสดงทั้ง 2 รายการ จำนวนสูงสุดของช่องเหล่านี้ที่แสดงคือ 10 ช่องจากออบเจ็กต์และ 10 ช่องจากคลาส
redemptionIssuers[]

string (int64 format)

ระบุผู้ออกบัตรแลกสิทธิ์ที่แลกแต้มผ่าน Smart Tap ได้ ระบบจะระบุผู้ออกบัตรแลกสิทธิ์ด้วยรหัสผู้ออกบัตร ผู้ออกบัตรแลกสิทธิ์ต้องกำหนดค่าคีย์ Smart Tap อย่างน้อย 1 รายการ

นอกจากนี้ คุณต้องตั้งค่าช่อง enableSmartTap และsmartTapRedemptionLevel ระดับออบเจ็กต์อย่างถูกต้องเพื่อให้บัตรรองรับการแตะอัจฉริยะ
countryCode

string

รหัสประเทศที่ใช้แสดงประเทศของการ์ด (เมื่อผู้ใช้ไม่ได้อยู่ในประเทศนั้น) รวมถึงแสดงเนื้อหาที่แปลแล้วเมื่อเนื้อหาไม่พร้อมใช้งานในภาษาของผู้ใช้
heroImage

object (Image)

รูปภาพแบนเนอร์ (ไม่บังคับ) ที่แสดงที่ด้านหน้าของการ์ด หากไม่มี จะไม่มีการแสดงข้อมูลใดๆ รูปภาพจะแสดงที่ความกว้าง 100%
wordMark
(deprecated)

object (Image)

เลิกใช้งานแล้ว
enableSmartTap

boolean

ระบุว่าคลาสนี้รองรับการแตะอัจฉริยะหรือไม่ นอกจากนี้ คุณต้องตั้งค่าช่อง redemptionIssuers และsmartTapRedemptionLevel ระดับออบเจ็กต์อย่างถูกต้องเพื่อให้บัตรรองรับการแตะอัจฉริยะ
hexBackgroundColor

string

สีพื้นหลังของการ์ด หากไม่ได้ตั้งค่า ระบบจะใช้สีหลักของรูปภาพหลัก และหากไม่ได้ตั้งค่ารูปภาพหลัก ระบบจะใช้สีหลักของโลโก้ รูปแบบคือ #rrggbb โดยที่ rrggbb คือไตรต์ RGB แบบฐาน 16 เช่น #ffcc00 นอกจากนี้ คุณยังใช้รูปแบบย่อของชุดค่า RGB ซึ่งก็คือ #rgb เช่น #fc0 ได้ด้วย
localizedIssuerName

object (LocalizedString)

สตริงที่แปลแล้วสำหรับ issuerName ความยาวสูงสุดที่แนะนำคือ 20 อักขระเพื่อให้สตริงแสดงเต็มรูปแบบบนหน้าจอขนาดเล็ก
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

ระบุว่าผู้ใช้และอุปกรณ์หลายรายจะบันทึกออบเจ็กต์เดียวกันซึ่งอ้างอิงคลาสนี้หรือไม่
callbackOptions

object (CallbackOptions)

ตัวเลือกการเรียกกลับที่จะใช้เพื่อโทรกลับหาผู้ออกใบอนุญาตสำหรับการบันทึก/ลบออบเจ็กต์สำหรับคลาสนี้ทุกครั้งโดยผู้ใช้ปลายทาง ออบเจ็กต์ทั้งหมดของคลาสนี้มีสิทธิ์ใช้การเรียกกลับ
securityAnimation

object (SecurityAnimation)

ข้อมูลเกี่ยวกับภาพเคลื่อนไหวเกี่ยวกับความปลอดภัย (ไม่บังคับ) หากตั้งค่านี้ ระบบจะแสดงภาพเคลื่อนไหวความปลอดภัยในรายละเอียดบัตร
viewUnlockRequirement

enum (ViewUnlockRequirement)

ดูตัวเลือกข้อกำหนดในการปลดล็อกสำหรับข้อเสนอ
wideTitleImage

object (Image)

รูปภาพชื่อแบบกว้างของข้อเสนอ หากระบุไว้ ระบบจะใช้รูปภาพนี้แทนรูปภาพชื่อที่ด้านซ้ายบนของมุมมองการ์ด
notifyPreference

enum (NotificationSettingsForUpdates)

การตั้งค่าว่าควรมีการแจ้งเตือนเมื่อมีการอัปเดตช่องในชั้นเรียนนี้หรือไม่ เมื่อตั้งค่าเป็น "แจ้งเตือน" เราจะพยายามเรียกให้ระบบแจ้งเตือนการอัปเดตช่องแก่ผู้ใช้ ระบบจะส่งการแจ้งเตือนเหล่านี้ไปยังผู้ใช้ก็ต่อเมื่อช่องเป็นส่วนหนึ่งของรายการที่อนุญาตเท่านั้น หากไม่ได้ระบุ ระบบจะไม่ทริกเกอร์การแจ้งเตือน การตั้งค่านี้มีอายุไม่นานและจะต้องตั้งค่าพร้อมกับคําขอ PATCH หรือ UPDATE แต่ละรายการ มิฉะนั้นการแจ้งเตือนจะไม่ทริกเกอร์
valueAddedModuleData[]

object (ValueAddedModuleData)

ข้อมูลข้อบังคับมูลค่าเพิ่ม (ไม่บังคับ) นักเรียนสูงสุด 10 คนต่อชั้นเรียน สำหรับบัตร ระบบจะแสดงเพียง 10 รายการ โดยให้ความสำคัญกับบัตรจากวัตถุ

RedemptionChannel

Enum
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

 อัปเดตประเภทข้อเสนอที่อ้างอิงโดยรหัสชั้นเรียนที่ระบุ