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)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
ช่อง
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[]
(deprecated)

object (LatLongPoint)

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

boolean

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

string

ค่าที่จะส่งไปยังเครื่องชำระเงินที่ผ่านการรับรองของ Smart Tap ผ่าน 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)

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

string

linkedObjectIds คือรายการออบเจ็กต์อื่นๆ เช่น ตั๋วเข้างาน บัตรสะสมคะแนน ข้อเสนอ ทั่วไป บัตรของขวัญ บัตรโดยสาร และบอร์ดดิ้งพาส ซึ่งควรแนบมากับออบเจ็กต์บัตรของขวัญนี้โดยอัตโนมัติ หากผู้ใช้บันทึกบัตรของขวัญนี้ ระบบจะพุช linkedObjectId เหล่านี้ไปยังกระเป๋าสตางค์ของผู้ใช้โดยอัตโนมัติ (เว้นแต่ผู้ใช้จะปิดการตั้งค่าเพื่อรับบัตรที่ลิงก์ดังกล่าว)

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

รหัสออบเจ็กต์ควรเป็นไปตามรูปแบบ issuer IDidentifier โดยที่รหัสแรกจะออกโดย Google และรหัสหลังจะเลือกโดยคุณ
notifyPreference

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

ข้อมูลโมดูลที่เพิ่มมูลค่าซึ่งไม่บังคับ สูงสุด 10 รายการบนวัตถุ

เมธอด

addmessage

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

get

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

insert

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

list

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

patch

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

update

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