REST Resource: loyaltyobject

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

การแสดง JSON 
{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "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#loyaltyObject"
classReference

object (LoyaltyClass)

สําเนาของช่องที่รับค่าของคลาสหลัก ระบบจะดึงข้อมูลฟิลด์เหล่านี้ระหว่างการเรียก GET
accountName

string

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

string

ตัวระบุบัญชีสะสมคะแนน ความยาวสูงสุดที่แนะนำคือ 20 อักขระ
loyaltyPoints

object (LoyaltyPoints)

ป้ายกำกับ คะแนนคงเหลือ และประเภทคะแนนสะสม
linkedOfferIds[]

string

รายการออบเจ็กต์ข้อเสนอที่ลิงก์กับบัตรสะสมคะแนนนี้ ออบเจ็กต์ข้อเสนอต้องมีอยู่ก่อนแล้ว

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

object (LoyaltyPoints)

ป้ายกำกับ คะแนนคงเหลือ และประเภทคะแนนสะสมสำหรับสมาชิกรอง แสดงนอกเหนือจากคะแนนสะสมหลัก
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

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

หากไม่ได้ตั้งค่านี้ แต่ตั้งค่าช่องระดับชั้นเรียน enableSmartTap และ redemptionIssuers ไว้อย่างถูกต้อง ระบบจะใช้ช่อง barcode.value หรือ accountId เป็นค่าสำรอง (หากมี)
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

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

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

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

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

ข้อมูลข้อบังคับมูลค่าเพิ่ม (ไม่บังคับ) สูงสุด 10 รายการบนวัตถุ

LoyaltyPoints

การแสดง JSON 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
ช่อง
label

string

ป้ายกำกับคะแนนสะสม เช่น "คะแนน" ความยาวสูงสุดที่แนะนําคือ 9 อักขระ
balance

object (LoyaltyPointsBalance)

คะแนนสะสมของเจ้าของบัญชี เช่น "500" หรือ "$10.00" ความยาวสูงสุดที่แนะนำคือ 7 อักขระ ช่องนี้ต้องระบุ loyaltyPoints และ secondaryLoyaltyPoints
localizedLabel

object (LocalizedString)

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

LoyaltyPointsBalance

การแสดง JSON 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
ช่อง
string

string

รูปแบบสตริงของยอดคงเหลือ ควรป้อนข้อมูลประเภทย่อยเพียงประเภทเดียว (สตริง, int, double, money)
int

integer

รูปแบบจำนวนเต็มของยอดคงเหลือ ควรป้อนข้อมูลประเภทย่อยเพียงประเภทเดียว (สตริง, int, double, money)
double

number

รูปแบบคู่ของยอดคงเหลือ ควรป้อนข้อมูลประเภทย่อยเพียงประเภทเดียว (สตริง, int, double, money)
money

object (Money)

รูปแบบเงินของยอดคงเหลือ ควรป้อนข้อมูลประเภทย่อยเพียงประเภทเดียว (สตริง, int, double, money)

เมธอด

addmessage

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

get

 แสดงผลออบเจ็กต์โปรแกรมสะสมคะแนนที่มีรหัสออบเจ็กต์ที่ระบุ

insert

 แทรกออบเจ็กต์โปรแกรมสะสมคะแนนที่มีรหัสและพร็อพเพอร์ตี้ที่ระบุ

list

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

modifylinkedofferobjects

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

patch

 อัปเดตออบเจ็กต์โปรแกรมสะสมคะแนนที่อ้างอิงโดยรหัสออบเจ็กต์ที่กำหนด

update

 อัปเดตออบเจ็กต์โปรแกรมสะสมคะแนนที่อ้างอิงโดยรหัสออบเจ็กต์ที่กำหนด