REST Resource: offerclass

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

การแสดง JSON 
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    object (LocalizedString)
  },
  "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),
  "wideTitleImage": {
    object (Image)
  }
}
ช่อง
kind
(deprecated)

string

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

string

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

enum (RedemptionChannel)

ต้องระบุ ช่องทางการแลกสิทธิ์ที่เกี่ยวข้องกับข้อเสนอนี้
provider

string

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

object (Image)

รูปภาพชื่อของข้อเสนอ รูปภาพนี้จะแสดงทั้งในรายละเอียดและมุมมองรายการของแอป
details

string

รายละเอียดของข้อเสนอ
finePrint

string

เงื่อนไขหรือเงื่อนไขของข้อเสนอ เช่น "เสื้อยืดของอดัมลด 20%"
helpUri

object (Uri)

ลิงก์ความช่วยเหลือสำหรับข้อเสนอ เช่น http://myownpersonaldomain.com/help
localizedTitle

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

สตริงที่แปลแล้วสำหรับรายละเอียด
localizedFinePrint

object (LocalizedString)

สตริงที่แปลแล้วสำหรับ FinePrint
shortTitle

string

ชื่อข้อเสนอแบบย่อ เช่น "ลด 20%" ซึ่งแสดงให้ผู้ใช้เห็นเพื่อเป็นการอ้างอิงอย่างรวดเร็วไปยังเนื้อหาของข้อเสนอ ความยาวสูงสุดที่แนะนำคือ 20 อักขระ
localizedShortTitle

object (LocalizedString)

สตริงที่แปลแล้วสำหรับชื่อย่อ ความยาวสูงสุดที่แนะนำคือ 20 อักขระ
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 หรือสถานะของชั้นเรียน ช่องนี้สามารถตั้งค่าเป็น 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 และระดับวัตถุ smartTapRedemptionLevel ให้ถูกต้องด้วย เพื่อให้บัตรรองรับการแตะอัจฉริยะ
countryCode

string

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

object (Image)

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

object (Image)

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

boolean

ระบุว่าคลาสนี้รองรับการแตะอัจฉริยะหรือไม่ นอกจากนี้ ต้องตั้งค่าช่อง redemptionIssuers และระดับวัตถุ smartTapRedemptionLevel ให้ถูกต้องด้วย เพื่อให้บัตรรองรับการแตะอัจฉริยะ
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)

ดูตัวเลือกข้อกำหนดในการปลดล็อกสำหรับข้อเสนอ
wideTitleImage

object (Image)

รูปภาพชื่อแบบกว้างของข้อเสนอ เมื่อระบุแล้ว ระบบจะใช้ขนาดนี้แทนรูปภาพชื่อที่ด้านบนซ้ายของมุมมองการ์ด

RedemptionChannel

Enum
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

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

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

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

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

วิธีการ

addmessage

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

get

 แสดงผลคลาสข้อเสนอที่มีรหัสคลาสที่ระบุ

insert

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

list

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

patch

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

update

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