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

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

localizedProgramName

object (LocalizedString)

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

localizedAccountNameLabel

object (LocalizedString)

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

localizedAccountIdLabel

object (LocalizedString)

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

localizedRewardsTierLabel

object (LocalizedString)

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

localizedRewardsTier

object (LocalizedString)

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

secondaryRewardsTierLabel

string

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

localizedSecondaryRewardsTierLabel

object (LocalizedString)

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

secondaryRewardsTier

string

รางวัลระดับรอง เช่น "Gold" หรือ "Platinum"

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 ใน linkModuleData (เมื่อแสดงผลออบเจ็กต์ ลิงก์ไปยังหน้าแรกจะแสดงในสิ่งที่มักเรียกว่าส่วน 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และหนึ่งในระดับออบเจ็กต์smartTapRedemptionValue ซึ่งก็คือช่องบาร์โค้ด.value, oraccountId` อย่างถูกต้องเพื่อให้บัตรรองรับการแตะอัจฉริยะ

countryCode

string

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

heroImage

object (Image)

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

wordMark
(deprecated)

object (Image)

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

enableSmartTap

boolean

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

hexBackgroundColor

string

สีพื้นหลังของการ์ด หากไม่ได้ตั้งค่าการใช้สีหลักของรูปภาพหลัก และหากไม่ได้ตั้งค่ารูปภาพหลัก ระบบจะใช้สีหลักของโลโก้ รูปแบบคือ #rrggbb โดยที่ rrggbb คือ 3 แฉกสามสีแบบเลขฐาน 16 เช่น #ffcc00 คุณยังสามารถใช้ทริปเปิล 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

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