REST Resource: genericobject

ทรัพยากร: genericObject

ออบเจ็กต์ทั่วไป

การแสดง JSON 
{
  "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
  ]
}
ช่อง
genericType

enum (GenericType)

ระบุ GenericType ของบัตร
cardTitle

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

string

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

object (Notifications)

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

string

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

string

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

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

object (Barcode)

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

object (Image)

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

object (TimeInterval)

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

object (ImageModuleData)

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

object (TextModuleData)

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

object (GroupingInfo)

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

string

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

object (RotatingBarcode)

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

enum (State)

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

boolean

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

object (Message)

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

object (PassConstraints)

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

object (SaveRestrictions)

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

object (ValueAddedModuleData)

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

string

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

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

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

GenericType

ประเภทของการ์ดทั่วไป

Enum
GENERIC_TYPE_UNSPECIFIED ประเภททั่วไปที่ไม่ระบุ
GENERIC_SEASON_PASS ตั๋วซีซัน
GENERIC_UTILITY_BILLS ใบเรียกเก็บเงินค่าสาธารณูปโภค
GENERIC_PARKING_PASS บัตรจอดรถ
GENERIC_VOUCHER บัตรกำนัล
GENERIC_GYM_MEMBERSHIP บัตรสมาชิกฟิตเนส
GENERIC_LIBRARY_MEMBERSHIP บัตรสมาชิกห้องสมุด
GENERIC_RESERVATIONS การจอง
GENERIC_AUTO_INSURANCE บัตรประกันภัยรถยนต์
GENERIC_HOME_INSURANCE บัตรประกันบ้าน
GENERIC_ENTRY_TICKET ตั๋วเข้าชม
GENERIC_RECEIPT ใบเสร็จ
GENERIC_LOYALTY_CARD บัตรสะสมคะแนน โปรดทราบว่าเราแนะนำให้ใช้บัตรประเภทบัตรสะสมคะแนนโดยเฉพาะแทนบัตรทั่วไปนี้ บัตรสะสมคะแนนประเภทเฉพาะจะมีฟีเจอร์และฟังก์ชันการทำงานมากกว่าบัตรประเภททั่วไป
GENERIC_OTHER ประเภทอื่นๆ

การแจ้งเตือน

ระบุว่าต้องเปิดใช้การแจ้งเตือนสำหรับออบเจ็กต์หรือไม่ เรารองรับ ExpiryNotification/UpcomingNotification เพียงรายการเดียวเท่านั้น expiryNotification มีความสำคัญเหนือ upcomingNotification กล่าวคือ หากมีการตั้งค่า expiryNotification เราจะไม่สนใจฟิลด์ upcomingNotification

การแสดง JSON 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
ช่อง
expiryNotification

object (ExpiryNotification)

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

object (UpcomingNotification)

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

ExpiryNotification

บ่งชี้ว่าผู้ออกบัตรต้องการให้ Google Wallet ส่งการแจ้งเตือนการหมดอายุ 2 วันก่อนวันที่บัตรจะหมดอายุ

การแสดง JSON 
{
  "enableNotification": boolean
}
ช่อง
enableNotification

boolean

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

UpcomingNotification

บ่งบอกว่าผู้ออกบัตรต้องการให้ Google Wallet ส่งการแจ้งเตือนวันหมดอายุของบัตรที่กําลังจะมาถึง 1 วันก่อนที่บัตรจะใช้งานได้

การแสดง JSON 
{
  "enableNotification": boolean
}
ช่อง
enableNotification

boolean

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

เมธอด

addmessage

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

get

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

insert

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

list

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

patch

 อัปเดตออบเจ็กต์ทั่วไปที่อิงตามรหัสออบเจ็กต์ที่ระบุ

update

 อัปเดตออบเจ็กต์ทั่วไปที่อิงตามรหัสออบเจ็กต์ที่ระบุ