REST Resource: giftcardobject

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

การแสดง JSON
{
  "kind": string,
  "classReference": {
    object (GiftCardClass)
  },
  "cardNumber": string,
  "pin": string,
  "balance": {
    object (Money)
  },
  "balanceUpdateTime": {
    object (DateTime)
  },
  "eventNumber": string,
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
ช่อง
kind
(deprecated)

string

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

classReference

object (GiftCardClass)

สำเนาของช่องที่รับช่วงมาจากชั้นเรียนหลัก ระบบจะดึงข้อมูลช่องเหล่านี้ระหว่าง GET

cardNumber

string

ต้องระบุ หมายเลขบัตร

pin

string

PIN ของบัตร

balance

object (Money)

ยอดเงินคงเหลือของบัตร

balanceUpdateTime

object (DateTime)

วันที่และเวลาที่อัปเดตยอดคงเหลือครั้งล่าสุด

ต้องใช้ออฟเซ็ต

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

eventNumber

string

หมายเลขกิจกรรมของบัตร เป็นช่องที่ไม่บังคับซึ่งบัตรของขวัญบางรายการใช้

id

string

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

classId

string

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

รหัสชั้นเรียนควรอยู่ในรูปแบบ issuer IDidentifierที่บัญชีแรกออกโดย Google และคุณเป็นผู้เลือกรายการหลัง

version
(deprecated)

string (int64 format)

เลิกใช้

state

enum (State)

ต้องระบุ สถานะของออบเจ็กต์ ช่องนี้ใช้เพื่อกำหนดการแสดงออบเจ็กต์ในแอป เช่น ย้ายออบเจ็กต์ inactive ไปยัง "บัตรที่หมดอายุ"

barcode

object (Barcode)

ประเภทและค่าของบาร์โค้ด

messages[]

object (Message)

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

validTimeInterval

object (TimeInterval)

ระยะเวลาที่ออบเจ็กต์นี้จะเป็น active และจะใช้ออบเจ็กต์ได้ สถานะของออบเจ็กต์จะเปลี่ยนเป็น expired เมื่อระยะเวลานี้ผ่านไปแล้ว

locations[]

object (LatLongPoint)

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

hasUsers

boolean

ระบุว่าออบเจ็กต์มีผู้ใช้หรือไม่ แพลตฟอร์มนี้เป็นผู้กำหนดค่าฟิลด์นี้

smartTapRedemptionValue

string

ค่าที่จะส่งไปยังเครื่องชำระเงินที่ได้รับการรับรองของการแตะอัจฉริยะผ่าน NFC สำหรับออบเจ็กต์นี้ นอกจากนี้จะต้องตั้งค่าช่องระดับชั้นเรียน enableSmartTap และ redemptionIssuers ให้ถูกต้องเพื่อให้บัตรรองรับการแตะอัจฉริยะ รองรับเฉพาะอักขระ ASCII

hasLinkedDevice

boolean

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

disableExpirationNotification

boolean

ระบุว่าควรระงับการแจ้งเตือนอย่างชัดเจนหรือไม่ หากตั้งค่าช่องนี้เป็น "จริง" โดยไม่คำนึงถึงช่อง messages ระบบจะระงับการแจ้งเตือนการหมดอายุให้ผู้ใช้ โดยค่าเริ่มต้น ระบบจะตั้งค่าช่องนี้เป็น "เท็จ"

ปัจจุบันตั้งค่านี้ได้สำหรับข้อเสนอเท่านั้น

infoModuleData

object (InfoModuleData)

เลิกใช้งานแล้ว โปรดใช้ textModulesData แทน

imageModulesData[]

object (ImageModuleData)

ข้อมูลโมดูลรูปภาพ จำนวนสูงสุดของช่องเหล่านี้ที่แสดงคือ 1 ช่องจากระดับออบเจ็กต์และ 1 ช่องสำหรับระดับออบเจ็กต์ของคลาส

textModulesData[]

object (TextModuleData)

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

rotatingBarcode

object (RotatingBarcode)

ประเภทและค่าของบาร์โค้ดแบบหมุนเวียน

heroImage

object (Image)

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

groupingInfo

object (GroupingInfo)

ข้อมูลที่ควบคุมวิธีจัดกลุ่มบัตรเข้าด้วยกัน

passConstraints

object (PassConstraints)

ส่งผ่านข้อจำกัดสำหรับออบเจ็กต์ รวมถึงการจำกัดการทำงานของ NFC และภาพหน้าจอ

saveRestrictions

object (SaveRestrictions)

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

เมธอด

addmessage

เพิ่มข้อความไปยังออบเจ็กต์บัตรของขวัญที่อ้างอิงโดยรหัสออบเจ็กต์ที่กำหนด

get

แสดงออบเจ็กต์บัตรของขวัญที่มีรหัสออบเจ็กต์ที่ระบุ

insert

แทรกออบเจ็กต์บัตรของขวัญที่มีรหัสและพร็อพเพอร์ตี้ที่กำหนด

list

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

patch

อัปเดตออบเจ็กต์บัตรของขวัญที่อ้างอิงโดยรหัสออบเจ็กต์ที่กำหนด

update

อัปเดตออบเจ็กต์บัตรของขวัญที่อ้างอิงโดยรหัสออบเจ็กต์ที่กำหนด