REST Resource: genericobject

{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "messages": [
    {
      object (Message)
    }
  ],
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ],
  "linkedObjectIds": [
    string
  ]
}

enum (GenericType)

ระบุว่าบัตรเป็นของ GenericType ใด

object (LocalizedString)

ต้องระบุ ส่วนหัวของบัตร ซึ่งโดยปกติจะเป็นชื่อธุรกิจ เช่น "XXX Gym" "AAA Insurance" ช่องนี้ต้องระบุและจะปรากฏในแถวส่วนหัวที่ด้านบนสุดของบัตร

object (LocalizedString)

ป้ายกำกับชื่อของบัตร เช่น สถานที่ที่ใช้บัตรนี้ได้ ปรากฏเหนือชื่อในแถวชื่อในมุมมองรายละเอียดบัตร

object (LocalizedString)

ต้องระบุ ชื่อบัตร เช่น "คูปองลด 50%" หรือ "บัตรห้องสมุด" หรือ "บัตรกำนัล" ช่องนี้ต้องกรอกข้อมูลและจะปรากฏในแถวชื่อของมุมมองรายละเอียดบัตร

object (Image)

รูปภาพโลโก้ของบัตร รูปภาพนี้จะแสดงในมุมมองรายละเอียดการ์ดที่ด้านซ้ายบน และในมุมมองรายการ/ภาพขนาดย่อด้วย หากไม่มีโลโก้ ระบบจะแสดงตัวอักษรแรกของ cardTitle เป็นโลโก้

string

สีพื้นหลังของการ์ด หากไม่ได้ตั้งค่า ระบบจะใช้สีหลักของรูปภาพหลัก และหากไม่ได้ตั้งค่ารูปภาพหลัก ระบบจะใช้สีหลักของโลโก้ และหากไม่ได้ตั้งค่าโลโก้ Google จะเลือกสีให้

object (Notifications)

การตั้งค่าการแจ้งเตือนที่เปิดใช้สำหรับออบเจ็กต์นี้

string

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

string

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

รหัสชั้นเรียนควรอยู่ในรูปแบบ issuerID.identifier โดยที่ issuerID ออกโดย Google และ identifier ที่คุณเลือก

object (Barcode)

ประเภทและค่าของบาร์โค้ด หากบัตรไม่มีบาร์โค้ด เราจะอนุญาตให้ผู้ออกบัตรตั้งค่า Barcode.alternate_text และแสดงเฉพาะค่านั้น

object (Image)

รูปภาพแบนเนอร์ที่แสดงที่ด้านหน้าของการ์ด (หากมี) รูปภาพจะแสดงที่ความกว้าง 100%

object (TimeInterval)

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

object (ImageModuleData)

ข้อมูลโมดูลรูปภาพ ระบบจะแสดงรูปภาพจากคลาสและรูปภาพจากระดับออบเจ็กต์เพียงรายการเดียวเมื่อตั้งค่าทั้ง 2 แบบ

object (TextModuleData)

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

object (LinksModuleData)

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

object (AppLinkData)

ลิงก์แอปหรือเว็บไซต์ที่ไม่บังคับซึ่งจะแสดงเป็นปุ่มด้านหน้าบัตร หากระบุ AppLinkData สําหรับคลาสที่เกี่ยวข้อง ระบบจะแสดงเฉพาะออบเจ็กต์ AppLinkData

object (GroupingInfo)

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

string

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

object (RotatingBarcode)

การตั้งค่า/รายละเอียดบาร์โค้ดแบบหมุน

enum (State)

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

boolean

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

object (Message)

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

object (PassConstraints)

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

object (Image)

โลโก้แบบกว้างของบัตร หากระบุไว้ ระบบจะใช้รูปภาพนี้แทนโลโก้ที่ด้านซ้ายบนของมุมมองการ์ด

object (SaveRestrictions)

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

object (ValueAddedModuleData)

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

string

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

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

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

{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}

object (ExpiryNotification)

ระบบจะทริกเกอร์การแจ้งเตือนในเวลาที่เจาะจงก่อนที่บัตรจะหมดอายุ

object (UpcomingNotification)

จะมีการทริกเกอร์การแจ้งเตือนในเวลาที่กำหนดก่อนที่บัตรจะใช้งานได้

{
  "enableNotification": boolean
}

boolean

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

{
  "enableNotification": boolean
}

boolean

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