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)
  }
}
ช่อง
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[]

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)

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

object (RotatingBarcode)

ประเภทและค่าบาร์โค้ดแบบหมุน
heroImage

object (Image)

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

object (GroupingInfo)

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

object (PassConstraints)

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

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

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

integer

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

number

ดุลยภาพแบบคู่ ควรป้อนข้อมูลเพียงประเภทย่อยเดียว (string, int, double, Money)
money

object (Money)

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

วิธีการ

addmessage

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

get

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

insert

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

list

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

modifylinkedofferobjects

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

patch

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

update

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