หน้านี้ได้รับการแปลโดย Cloud Translation API

REST Resource: giftcardclass

แหล่งข้อมูล: GiftCardClass
- การแสดง JSON
เมธอด

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

การแสดง JSON

การแสดง JSON
{ "kind": string, "merchantName": string, "programLogo": { object (`Image`) }, "pinLabel": string, "eventNumberLabel": string, "allowBarcodeRedemption": boolean, "localizedMerchantName": { object (`LocalizedString`) }, "localizedPinLabel": { object (`LocalizedString`) }, "localizedEventNumberLabel": { object (`LocalizedString`) }, "cardNumberLabel": string, "localizedCardNumberLabel": { 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`), "wideProgramLogo": { object (`Image`) } }

{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    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),
  "wideProgramLogo": {
    object (Image)
  }
}

ช่อง
`kind (deprecated)`	`string` รายการนี้เลิกใช้งานแล้ว ระบุประเภทของทรัพยากร ค่า: สตริงคงที่ `"walletobjects#giftCardClass"`
`merchantName`	`string` ชื่อผู้ขาย เช่น "เครื่องแต่งกายของอัครเดช" แอปอาจแสดงจุดไข่ปลาหลังจากอักขระ 20 ตัวแรกเพื่อให้แน่ใจว่าสตริงทั้งหมดจะแสดงในหน้าจอขนาดเล็ก
`programLogo`	`object (Image)` โลโก้ของโปรแกรมหรือบริษัทบัตรของขวัญ โลโก้นี้จะแสดงทั้งในรายละเอียดและมุมมองรายการของแอป
`pinLabel`	`string` ป้ายกำกับที่จะแสดงสำหรับ PIN เช่น "PIN 4 หลัก"
`eventNumberLabel`	`string` ป้ายกำกับที่จะแสดงสำหรับหมายเลขเหตุการณ์ เช่น "เหตุการณ์เป้าหมาย #"
`allowBarcodeRedemption`	`boolean` ระบุว่าผู้ขายรองรับการแลกบัตรของขวัญโดยใช้บาร์โค้ดหรือไม่ หากจริง แอปจะแสดงบาร์โค้ดสำหรับบัตรของขวัญบนหน้าจอรายละเอียดบัตรของขวัญ หากเป็นเท็จ ระบบจะไม่แสดงบาร์โค้ด
`localizedMerchantName`	`object (LocalizedString)` สตริงที่แปลแล้วสำหรับ MerchantName แอปอาจแสดงจุดไข่ปลาหลังจากอักขระ 20 ตัวแรกเพื่อให้แน่ใจว่าสตริงทั้งหมดจะแสดงบนหน้าจอขนาดเล็ก
`localizedPinLabel`	`object (LocalizedString)` สตริงที่แปลสำหรับ PinLabel
`localizedEventNumberLabel`	`object (LocalizedString)` สตริงที่แปลสำหรับ eventNumberLabel
`cardNumberLabel`	`string` ป้ายกำกับที่จะแสดงสำหรับหมายเลขบัตร เช่น "หมายเลขบัตร"
`localizedCardNumberLabel`	`object (LocalizedString)` สตริงที่แปลสำหรับ cardNumberLabel
`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 ช่องจากคลาส
`linksModuleData`	`object (LinksModuleData)` ข้อมูลโมดูลลิงก์ หากมีการกำหนดข้อมูลโมดูลลิงก์ไว้ในออบเจ็กต์ด้วย ระบบจะแสดงทั้ง 2 รายการ
`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)` ดูตัวเลือกข้อกำหนดในการปลดล็อกสำหรับบัตรของขวัญ
`wideProgramLogo`	`object (Image)` โลโก้แบบกว้างของโปรแกรมหรือบริษัทบัตรของขวัญ เมื่อมีการระบุ ข้อมูลนี้จะถูกใช้แทนโลโก้โปรแกรมที่ด้านบนซ้ายของมุมมองการ์ด

วิธีการ
`addmessage`	เพิ่มข้อความไปยังประเภทบัตรของขวัญที่อ้างอิงตามรหัสชั้นเรียนที่ระบุ
`get`	แสดงประเภทบัตรของขวัญที่มีรหัสคลาสที่ระบุ
`insert`	แทรกประเภทบัตรของขวัญที่มีรหัสและพร็อพเพอร์ตี้ที่ระบุ
`list`	แสดงรายการประเภทบัตรของขวัญทั้งหมดสำหรับรหัสผู้ออกบัตรที่ระบุ
`patch`	อัปเดตประเภทบัตรของขวัญตามรหัสชั้นเรียนที่ระบุ
`update`	อัปเดตประเภทบัตรของขวัญตามรหัสชั้นเรียนที่ระบุ

REST Resource: giftcardclass

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

วิธีการ

`addmessage`

`get`

`insert`

`list`

`patch`

`update`