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,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
ช่อง
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 ซึ่ง Google เป็นผู้ออก issuerID และคุณเป็นผู้เลือก identifier ตัวระบุที่ไม่ซ้ำกันจะมีได้เฉพาะอักขระที่เป็นตัวอักษรและตัวเลขคละกัน, ., _ หรือ -

classId

string

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

รหัสชั้นเรียนควรอยู่ในรูปแบบ issuerID.identifier ซึ่ง Google เป็นผู้ออก issuerID ให้ และคุณเป็นผู้เลือก identifier

barcode

object (Barcode)

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

heroImage

object (Image)

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

validTimeInterval

object (TimeInterval)

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

imageModulesData[]

object (ImageModuleData)

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

textModulesData[]

object (TextModuleData)

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

groupingInfo

object (GroupingInfo)

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

smartTapRedemptionValue

string

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

rotatingBarcode

object (RotatingBarcode)

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

state

enum (State)

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

hasUsers

boolean

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

passConstraints

object (PassConstraints)

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

saveRestrictions

object (SaveRestrictions)

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

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_OTHER ประเภทอื่น

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

ระบุว่าออบเจ็กต์ต้องเปิดใช้การแจ้งเตือนไหม เรารองรับ ExpiryNotification/SchedulingNotification เพียง 1 รายการเท่านั้น 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

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