REST Resource: giftcardclass

ทรัพยากร: GiftCardClass

การแสดง JSON 
{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    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),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "merchantLocations": [
    {
      object (MerchantLocation)
    }
  ]
}
ช่อง
kind
(deprecated)

string

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

string

ชื่อผู้ขาย เช่น "Adam's Apparel" แอปอาจแสดงเครื่องหมายจุดประยอยต่อจากอักขระ 20 ตัวแรกเพื่อให้แน่ใจว่าสตริงจะแสดงอย่างเต็มรูปแบบบนหน้าจอขนาดเล็ก
pinLabel

string

ป้ายกำกับที่จะแสดงสำหรับ PIN เช่น "PIN 4 หลัก"
eventNumberLabel

string

ป้ายกํากับที่จะแสดงสําหรับหมายเลขเหตุการณ์ เช่น "เหตุการณ์เป้าหมาย #"
allowBarcodeRedemption

boolean

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

object (LocalizedString)

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

object (LocalizedString)

สตริงที่แปลแล้วสำหรับ pinLabel
localizedEventNumberLabel

object (LocalizedString)

สตริงที่แปลแล้วสําหรับ eventNumberLabel
cardNumberLabel

string

ป้ายกำกับที่จะแสดงสำหรับหมายเลขบัตร เช่น "หมายเลขบัตร"
localizedCardNumberLabel

object (LocalizedString)

สตริงที่แปลแล้วสําหรับ cardNumberLabel
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 หรือ 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)

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

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

object (MerchantLocation)

สถานที่ตั้งของผู้ขาย โดยชั้นเรียนจะมีนักเรียนได้สูงสุด 10 คน ระบบจะปฏิเสธ MerchantLocation เพิ่มเติมที่เพิ่มเกิน 10 รายการ ตำแหน่งเหล่านี้จะทริกเกอร์การแจ้งเตือนเมื่อผู้ใช้เข้ามาในรัศมีที่กำหนดไว้ของจุด ช่องนี้จะแทนที่ LatLongPoints ที่เลิกใช้งานแล้ว

เมธอด

addmessage

 เพิ่มข้อความลงในคลาสบัตรของขวัญที่อ้างอิงโดยรหัสคลาสที่ระบุ

get

 แสดงผลคลาสบัตรของขวัญที่มีรหัสคลาสที่ระบุ

insert

 แทรกคลาสบัตรของขวัญที่มีรหัสและพร็อพเพอร์ตี้ที่ระบุ

list

 แสดงรายการคลาสบัตรของขวัญทั้งหมดสำหรับรหัสผู้ออกบัตรที่ระบุ

patch

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

update

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