REST Resource: loyaltyclass

แหล่งข้อมูล: LoyaltyClass

การแสดง JSON 
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  }
}
ช่อง
kind
(deprecated)

string

ระบุประเภทของทรัพยากร ค่า: สตริงคงที่ "walletobjects#loyaltyClass"
programName

string

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

string

ป้ายกำกับชื่อบัญชี เช่น "ชื่อสมาชิก" ความยาวสูงสุดที่แนะนำคือ 15 อักขระเพื่อให้สตริงทั้งหมดแสดงในหน้าจอขนาดเล็ก
accountIdLabel

string

ป้ายกำกับรหัสบัญชี เช่น "รหัสสมาชิก" ความยาวสูงสุดที่แนะนำคือ 15 อักขระเพื่อให้สตริงทั้งหมดแสดงในหน้าจอขนาดเล็ก
rewardsTierLabel

string

ป้ายกำกับระดับรางวัล เช่น "ระดับรางวัล" ความยาวสูงสุดที่แนะนำคือ 9 อักขระเพื่อให้สตริงทั้งหมดแสดงในหน้าจอขนาดเล็ก
rewardsTier

string

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

object (LocalizedString)

สตริงที่แปลแล้วสำหรับ programName แอปอาจแสดงจุดไข่ปลาหลังจากอักขระ 20 ตัวแรกเพื่อให้แน่ใจว่าสตริงทั้งหมดจะแสดงในหน้าจอขนาดเล็ก
localizedAccountNameLabel

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

string

ป้ายกำกับระดับรางวัลรอง เช่น "ระดับรางวัล"
localizedSecondaryRewardsTierLabel

object (LocalizedString)

สตริงที่แปลสำหรับ ViceRewardsTierLabel
secondaryRewardsTier

string

รางวัลระดับรอง เช่น "โกลด์" หรือ "แพลตินัม"
localizedSecondaryRewardsTier

object (LocalizedString)

สตริงที่แปลสำหรับsecondaryRewardsTier
discoverableProgram

object (DiscoverableProgram)

ข้อมูลเกี่ยวกับวิธีที่ระบบสามารถค้นพบและสร้างอินสแตนซ์ของชั้นเรียนได้จากภายในแอป Google Pay
classTemplateInfo

object (ClassTemplateInfo)

ข้อมูลเทมเพลตเกี่ยวกับวิธีการแสดงชั้นเรียน หากไม่ได้ตั้งค่า Google จะใช้ชุดฟิลด์เริ่มต้นเพื่อแสดงแทน
id

string

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

string (int64 format)

เลิกใช้
issuerName

string

ต้องระบุ ชื่อผู้ออกบัตร ความยาวสูงสุดที่แนะนำคือ 20 อักขระเพื่อให้สตริงทั้งหมดแสดงในหน้าจอขนาดเล็ก
messages[]

object (Message)

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

boolean

เลิกใช้งานแล้ว โปรดใช้ multipleDevicesAndHoldersAllowedStatus แทน
homepageUri

object (Uri)

URI หน้าแรกของแอปพลิเคชันของคุณ การป้อน URI ในช่องนี้จะมีลักษณะการทำงานแบบเดียวกับการป้อนข้อมูล URI ใน linkedModuleData (เมื่อแสดงผลออบเจ็กต์ ลิงก์ไปยังหน้าแรกจะแสดงในสิ่งที่มักเรียกว่าส่วน linkModuleData ของออบเจ็กต์)
locations[]

object (LatLongPoint)

หมายเหตุ: ปัจจุบันช่องนี้ยังไม่รองรับการเรียกการแจ้งเตือนทางภูมิศาสตร์
reviewStatus

enum (ReviewStatus)

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

คุณควรเก็บฟิลด์นี้ไว้ในdraftขณะที่ชั้นเรียนอยู่ระหว่างการพัฒนา ใช้คลาส draft เพื่อสร้างออบเจ็กต์ใดๆ ไม่ได้

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

เมื่ออัปเดตชั้นเรียนที่ approved อยู่แล้ว คุณควรตั้งค่าช่องนี้เป็น underReview ต่อไป
review

object (Review)

ความคิดเห็นในรีวิวที่แพลตฟอร์มกำหนดเมื่อชั้นเรียนมีสถานะเป็น approved หรือ rejected
infoModuleData
(deprecated)

object (InfoModuleData)

เลิกใช้งานแล้ว โปรดใช้ textModulesData แทน
imageModulesData[]

object (ImageModuleData)

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

object (TextModuleData)

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

string (int64 format)

ระบุว่าผู้ออกบัตรรายใดสามารถแลกบัตรผ่าน Smart Tap ได้ ผู้ออกการแลกสิทธิ์จะระบุตามรหัสผู้ออกบัตร ผู้ออกการแลกสิทธิ์ต้องกำหนดค่าคีย์การแตะอัจฉริยะไว้อย่างน้อย 1 รายการ

นอกจากนี้ คุณต้องตั้งค่าช่อง enableSmartTap และ 1 ในออบเจ็กต์ smartTapRedemptionValue ระดับวัตถุ , oraccountId" ให้ถูกต้องด้วย เพื่อให้บัตรรองรับการแตะอัจฉริยะ
countryCode

string

รหัสประเทศที่ใช้แสดงประเทศของการ์ด (เมื่อผู้ใช้ไม่ได้อยู่ในประเทศนั้น) รวมถึงแสดงเนื้อหาที่แปลแล้วเมื่อเนื้อหาไม่มีในภาษาของผู้ใช้
heroImage

object (Image)

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

object (Image)

เลิกใช้งานแล้ว
enableSmartTap

boolean

ระบุว่าคลาสนี้รองรับการแตะอัจฉริยะหรือไม่ นอกจากนี้ คุณต้องตั้งค่าช่อง redemptionIssuers และ 1 ในออบเจ็กต์ smartTapRedemptionLevel ระดับวัตถุ , or accountId" ให้ถูกต้องด้วย เพื่อให้บัตรรองรับการแตะอัจฉริยะ
hexBackgroundColor

string

สีพื้นหลังของการ์ด หากไม่ได้กำหนดสีที่โดดเด่นของรูปภาพหลัก และหากไม่ได้ตั้งค่ารูปภาพหลัก ระบบจะใช้สีที่โดดเด่นของโลโก้ รูปแบบคือ #rrggbb โดยที่ rrggbb เป็น 3 แบบ RGB แบบเลขฐาน 16 เช่น #ffcc00 คุณยังใช้ 3 เวอร์ชันย่อของ RGB ซึ่งก็คือ #rgb ได้ เช่น #fc0
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

ตัวเลือกโค้ดเรียกกลับที่ใช้เพื่อเรียกผู้ออกใบรับรองกลับเมื่อผู้ใช้ปลายทางบันทึก/ลบออบเจ็กต์สำหรับคลาสนี้ทุกครั้ง ออบเจ็กต์ทั้งหมดของคลาสนี้มีสิทธิ์สำหรับการติดต่อกลับ
securityAnimation

object (SecurityAnimation)

ข้อมูลเพิ่มเติมเกี่ยวกับภาพเคลื่อนไหวเพื่อความปลอดภัย หากตั้งค่าไว้ ภาพเคลื่อนไหวเพื่อความปลอดภัยจะแสดงในรายละเอียดบัตร
viewUnlockRequirement

enum (ViewUnlockRequirement)

ดูตัวเลือกปลดล็อกข้อกำหนดสำหรับบัตรสะสมคะแนน

DiscoverableProgram

ข้อมูลเกี่ยวกับวิธีที่อาจค้นพบและสร้างอินสแตนซ์ของชั้นเรียนได้จากภายในแอป Android Pay ซึ่งทำได้โดยการค้นหาโปรแกรมความภักดีหรือบัตรของขวัญ แล้วสแกนหรือป้อนข้อมูลด้วยตนเอง

การแสดง JSON 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
ช่อง
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

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

object (DiscoverableProgramMerchantSigninInfo)

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

enum (State)

สถานะระดับการเข้าถึงของโปรแกรมที่ค้นพบได้

DiscoverableProgramMerchantSignupInfo

ข้อมูลเกี่ยวกับขั้นตอนการลงชื่อสมัครใช้โปรแกรมที่ผู้ขายโฮสต์

การแสดง JSON 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
ช่อง
signupWebsite

object (Uri)

URL ที่จะนำผู้ใช้ไปยังเว็บไซต์ลงชื่อสมัครใช้ของผู้ขาย
signupSharedDatas[]

enum (SharedDataType)

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

SharedDataType

Enum
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS ฟิลด์ที่อยู่บรรทัดเดียว
ADDRESS_LINE_1 ช่องที่อยู่หลายบรรทัด
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

ข้อมูลเกี่ยวกับขั้นตอนการลงชื่อเข้าใช้ที่ผู้ขายโฮสต์ของโปรแกรม

การแสดง JSON 
{
  "signinWebsite": {
    object (Uri)
  }
}
ช่อง
signinWebsite

object (Uri)

URL ที่จะนำผู้ใช้ไปยังเว็บไซต์สำหรับลงชื่อเข้าใช้ของผู้ขาย

รัฐ

Enum
STATE_UNSPECIFIED
TRUSTED_TESTERS แสดงต่อผู้ทดสอบที่มีสิทธิ์เข้าถึงบัญชีผู้ออกบัตรเท่านั้น
trustedTesters

ชื่อแทนเดิมสำหรับ TRUSTED_TESTERS เลิกใช้งานแล้ว
LIVE ปรากฏแก่ทุกคน
live

ชื่อแทนเดิมสำหรับ LIVE เลิกใช้งานแล้ว
DISABLED มองไม่เห็น
disabled

ชื่อแทนเดิมสำหรับ DISABLED เลิกใช้งานแล้ว

วิธีการ

addmessage

 เพิ่มข้อความไปยังระดับการสะสมคะแนนที่อ้างอิงตามรหัสชั้นเรียนที่ระบุ

get

 แสดงผลคลาสการสะสมคะแนนที่มีรหัสคลาสที่ระบุ

insert

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

list

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

patch

 อัปเดตคลาสการสะสมคะแนนตามรหัสชั้นเรียนที่ระบุ

update

 อัปเดตคลาสการสะสมคะแนนตามรหัสชั้นเรียนที่ระบุ