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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
ช่อง
kind
(deprecated)

string

ระบุว่าทรัพยากรนี้เป็นประเภทใด ค่า: สตริงคงที่ "walletobjects#giftCardClass"

merchantName

string

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

pinLabel

string

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

eventNumberLabel

string

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

allowBarcodeRedemption

boolean

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

localizedMerchantName

object (LocalizedString)

สตริงที่แปลแล้วสำหรับ sellersName แอปอาจแสดงจุดไข่ปลาหลังอักขระ 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 (เมื่อแสดงผลออบเจ็กต์ ลิงก์ไปยังหน้าแรกจะแสดงในสิ่งที่มักมองว่าเป็นส่วนลิงก์ModuleData ของออบเจ็กต์)

locations[]

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)

ข้อมูลโมดูลข้อความ หากมีการกำหนดข้อมูลโมดูลข้อความไว้ในคลาสด้วย ทั้งสองรายการจะแสดงขึ้น จำนวนสูงสุดของฟิลด์เหล่านี้ที่แสดงคือ 10 รายการจากออบเจ็กต์ และ 10 รายการจากคลาส

redemptionIssuers[]

string (int64 format)

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

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

countryCode

string

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

heroImage

object (Image)

รูปภาพแบนเนอร์ที่ไม่บังคับซึ่งแสดงอยู่ด้านหน้าของการ์ด หากไม่มี ก็จะไม่แสดงผลใดๆ รูปภาพจะแสดงที่ความกว้าง 100%

wordMark
(deprecated)

object (Image)

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

enableSmartTap

boolean

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

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

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

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

securityAnimation

object (SecurityAnimation)

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

viewUnlockRequirement

enum (ViewUnlockRequirement)

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

เมธอด

addmessage

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

get

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

insert

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

list

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

patch

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

update

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