REST Resource: genericobject

ทรัพยากร: genericObject

รหัสทั่วไปของออบเจ็กต์ทั่วไป: 121

การแสดง 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)
  }
}
ช่อง
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 รูปภาพจากคลาสและ 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 และภาพหน้าจอ

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/พูดถึงการแจ้งเตือนนั้นเพียง 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

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