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

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

object (RotatingBarcode)

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

object (Image)

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

object (GroupingInfo)

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

object (PassConstraints)

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

object (SaveRestrictions)

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

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

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

integer

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

number

ยอดคงเหลือ 2 เท่า ควรป้อนข้อมูลประเภทย่อยเหล่านี้เพียง 1 ประเภทเท่านั้น (string, int, Double, money)
money

object (Money)

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

เมธอด

addmessage

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

get

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

insert

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

list

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

modifylinkedofferobjects

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

patch

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

update

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