REST Resource: subscriptions

แหล่งข้อมูล: การสมัครใช้บริการ

เทมเพลต JSON สําหรับการสมัครใช้บริการ

การแสดง JSON 
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
ช่อง
customerId

string

พร็อพเพอร์ตี้นี้จะแสดงในการตอบสนองโดยเป็นตัวระบุที่ไม่ซ้ํากันที่ Google สร้างขึ้นเสมอ ในคําขอ พร็อพเพอร์ตี้นี้อาจเป็นโดเมนหลักหรือตัวระบุที่ไม่ซ้ํากันที่ Google สร้างขึ้น
subscriptionId

string

subscriptionId คือตัวระบุการสมัครใช้บริการและเป็นเอกลักษณ์สําหรับลูกค้าแต่ละราย พร็อพเพอร์ตี้นี้เป็นพร็อพเพอร์ตี้ที่จําเป็น เนื่องจาก subscriptionId จะเปลี่ยนแปลงเมื่อมีการอัปเดตการสมัครใช้บริการ เราจึงไม่แนะนําให้ใช้รหัสนี้เป็นคีย์สําหรับข้อมูลถาวร ใช้ subscriptionId ตามที่อธิบายไว้ในเรียกดูการสมัครใช้บริการทั้งหมดของตัวแทนจําหน่าย
skuId

string

พร็อพเพอร์ตี้ที่จําเป็น skuId คือตัวระบุระบบที่ไม่ซ้ํากันสําหรับ SKU ของผลิตภัณฑ์ที่มอบหมายให้กับลูกค้าในการสมัครใช้บริการ สําหรับผลิตภัณฑ์และ SKU ที่พร้อมใช้งานใน API เวอร์ชันนี้ โปรดดูที่รหัสผลิตภัณฑ์และ SKU
creationTime

string (int64 format)

พร็อพเพอร์ตี้ creationTime คือวันที่สร้างการสมัครใช้บริการ หน่วยเป็นมิลลิวินาทีโดยใช้รูปแบบ Epoch ดูตัวอย่างตัวแปลง Epoch
kind

string

ระบุทรัพยากรเป็นการสมัครใช้บริการ ค่า: reseller#subscription
seats

object (Seats)

พร็อพเพอร์ตี้นี้เป็นพร็อพเพอร์ตี้ที่จําเป็น จํานวนและใบอนุญาตใบอนุญาตของผู้ใช้ในแพ็กเกจ
renewalSettings

object (RenewalSettings)

การตั้งค่าการต่ออายุสําหรับแพ็กเกจสัญญาผูกมัดรายปี โปรดดูข้อมูลโดยละเอียดในตัวเลือกการต่ออายุในศูนย์ช่วยเหลือของผู้ดูแลระบบ
purchaseOrderId

string

พร็อพเพอร์ตี้นี้ไม่บังคับ ข้อมูลใบสั่งซื้อ (PO) นี้มีไว้สําหรับตัวแทนจําหน่ายที่จะใช้การติดตามการใช้งานของบริษัท หากระบุค่า purchaseOrderId ค่าดังกล่าวจะปรากฏในการตอบกลับ API และจะแสดงในใบแจ้งหนี้ ที่พักยอมรับข้อความล้วนได้สูงสุด 80 อักขระ
status

string

พร็อพเพอร์ตี้นี้ไม่บังคับ
resourceUiUrl

string

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

string

ช่องแบบอ่านอย่างเดียวที่แสดงวิธีการเรียกเก็บเงินปัจจุบันสําหรับการสมัครใช้บริการ
suspensionReasons[]

string

ช่องแบบอ่านอย่างเดียวที่มีการแจกแจงรายละเอียดทั้งหมดของเหตุผลการระงับปัจจุบันสําหรับการสมัครใช้บริการ เป็นไปได้ที่การสมัครใช้บริการอาจมีสาเหตุที่ทําให้เกิดคําถามที่ทับซ้อนกันหลายรายการพร้อมกัน การสมัครใช้บริการ STATUS มีระยะเวลาอยู่ที่ SUSPENDED จนกว่าจะมีการนําการระงับที่รอดําเนินการทั้งหมดออก

ตัวเลือกที่เป็นไปได้มีดังนี้

  • PENDING_TOS_ACCEPTANCE - ลูกค้าไม่ได้ลงชื่อเข้าสู่ระบบและยอมรับข้อกําหนดในการให้บริการจากพาร์ทเนอร์ G Suite
  • RENEWAL_WITH_TYPE_CANCEL - สัญญาผูกมัดของลูกค้าสิ้นสุดและยกเลิกบริการเมื่อสิ้นสุดระยะเวลา
  • RESELLER_INITIATED - การระงับด้วยตนเองที่ตัวแทนจําหน่ายเรียกใช้
  • TRIAL_ENDED - ช่วงทดลองใช้ของลูกค้าหมดอายุโดยไม่มีการเลือกแผน
  • OTHER - ลูกค้าถูกระงับด้วยเหตุผลภายในของ Google (เช่น การละเมิดหรืออื่นๆ)

customerDomain

string

ชื่อโดเมนหลักของลูกค้า
dealCode

string

รหัสที่ออกโดย Google (สูงสุด 100 อักขระ) สําหรับราคาลดในแพ็กเกจการสมัครใช้บริการ รหัสดีลต้องอยู่ในคําขอของ insert จึงจะได้รับส่วนลด พร็อพเพอร์ตี้นี้เป็นแบบไม่บังคับ แต่จะใช้ราคาปกติหากเว้นว่างไว้
skuName

string

ชื่อที่แสดงภายนอกแบบอ่านอย่างเดียวสําหรับ SKU ของผลิตภัณฑ์ที่มอบหมายให้กับลูกค้าในการสมัครใช้บริการ ชื่อ SKU อาจเปลี่ยนแปลงได้ตามที่ Google เห็นสมควร สําหรับผลิตภัณฑ์และ SKU ที่พร้อมใช้งานใน API เวอร์ชันนี้ โปรดดูที่รหัสผลิตภัณฑ์และ SKU
plan

object

ต้องระบุพร็อพเพอร์ตี้ plan ใน API เวอร์ชันนี้ แพ็กเกจ G Suite เป็นแพ็กเกจแบบยืดหยุ่น แพ็กเกจสัญญาผูกมัดรายปี และแพ็กเกจช่วงทดลองใช้ฟรี 30 วัน ดูข้อมูลเพิ่มเติมเกี่ยวกับแพ็กเกจการชําระเงินของ API ได้ที่แนวคิด API
plan.planName

string

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

ค่าที่เป็นไปได้มีดังนี้

  • ANNUAL_MONTHLY_PAY — แพ็กเกจสัญญาผูกมัดรายปีพร้อมการชําระเงินรายเดือน
  • ANNUAL_YEARLY_PAY — แพ็กเกจสัญญาผูกมัดรายปีพร้อมการชําระเงินรายปี
  • FLEXIBLE — แพ็กเกจแบบยืดหยุ่น
  • TRIAL — แพ็กเกจทดลองใช้ฟรี 30 วัน การสมัครใช้บริการในช่วงทดลองใช้จะถูกระงับหลังจากวันที่ 30 ฟรีหากไม่มีการกําหนดแพ็กเกจการชําระเงิน การเรียกใช้ changePlan จะกําหนดแพ็กเกจการชําระเงินให้กับช่วงทดลองใช้ แต่จะไม่เปิดใช้งานแพ็กเกจ ช่วงทดลองใช้จะเริ่มแพ็กเกจการชําระเงินที่กําหนดโดยอัตโนมัติหลังจากช่วงทดลองใช้ฟรีวันที่ 30 หรือทันทีหลังจากโทรหา startPaidService
  • FREE - แพ็กเกจฟรีมีไว้สําหรับ Cloud Identity SKU เท่านั้นและไม่มีค่าใช้จ่ายใดๆ

plan.isCommitmentPlan

boolean

ค่าบูลีนของ isCommitmentPlan' ระบุว่าแพ็กเกจนี้เป็นสัญญาผูกมัดรายปี:

  • true — แพ็กเกจการสมัครใช้บริการเป็นแพ็กเกจสัญญาผูกมัดรายปี
  • false — แพ็กเกจดังกล่าวไม่ใช่แพ็กเกจสัญญาผูกมัดรายปี
plan.commitmentInterval

object

ใน API เวอร์ชันนี้ แผนสัญญาผูกมัดรายปีคือ 1 ปี

plan.commitmentInterval.startTime

string (int64 format)

แผนสัญญาผูกมัดรายปี 'startTime หน่วยเป็นมิลลิวินาทีโดยใช้รูปแบบ UNIX Epoch ดูตัวอย่างตัวแปลง Epoch
plan.commitmentInterval.endTime

string (int64 format)

แผนสัญญาผูกมัดรายปี 'endTime หน่วยเป็นมิลลิวินาทีโดยใช้รูปแบบ UNIX Epoch ดูตัวอย่างตัวแปลง Epoch
trialSettings

object

สัญญาผูกมัดรายปีของ G Suite และแพ็กเกจการชําระเงินแบบยืดหยุ่นอาจอยู่ในช่วงทดลองใช้ฟรี 30 วัน สําหรับข้อมูลเพิ่มเติม โปรดดูแนวคิด API
trialSettings.isInTrial

boolean

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

  • true — แพ็กเกจอยู่ระหว่างการทดลองใช้
  • false — แพ็กเกจไม่ได้อยู่ในช่วงทดลองใช้
trialSettings.trialEndTime

string (int64 format)

วันที่ช่วงทดลองใช้สิ้นสุด ค่าจะอยู่ในหน่วยมิลลิวินาทีที่ใช้รูปแบบ UNIX Epoch ดูตัวอย่างตัวแปลง Epoch
transferInfo

object

ข้อมูลที่เกี่ยวข้องกับการโอนแบบอ่านอย่างเดียวสําหรับการสมัครใช้บริการ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเรียกดูลูกค้าที่โอนได้
transferInfo.transferabilityExpirationTime

string (int64 format)

เวลาที่โทเค็นการโอนหรือความตั้งใจในการโอนจะหมดอายุ เวลาในหน่วยมิลลิวินาทีที่ใช้รูปแบบ UNIX Epoch
transferInfo.minimumTransferableSeats

integer

เมื่อแทรกการสมัครใช้บริการ คือจํานวนต่ําสุดของใบอนุญาตที่แสดงในคําสั่งซื้อการโอนของผลิตภัณฑ์นี้ เช่น หากลูกค้ามีผู้ใช้ 20 ราย ตัวแทนจําหน่ายจะโอนคําสั่งซื้อของลูกค้าจํานวน 15 ที่นั่งไม่ได้ ใบอนุญาตที่มีขั้นต่ําคือ 20 ที่นั่ง
transferInfo.currentLegacySkuId

string

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

ที่นั่ง

เทมเพลต JSON สําหรับที่นั่งการสมัครใช้บริการ

การแสดง JSON 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
ช่อง
numberOfSeats

integer

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

maximumNumberOfSeats

integer

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

licensedNumberOfSeats

integer

ช่องแบบอ่านอย่างเดียวที่มีจํานวนผู้ใช้ปัจจุบันที่ได้รับการมอบหมายใบอนุญาตสําหรับผลิตภัณฑ์ที่กําหนดไว้ใน skuId ค่าของช่องนี้เทียบเท่ากับจํานวนตัวเลขของผู้ใช้ที่ส่งคืนโดยเมธอด Enterprise License Manager API: listForProductAndSku
kind

string

ระบุทรัพยากรเป็นการตั้งค่าที่นั่งสําหรับการสมัครใช้บริการ ค่า: subscriptions#seats

การตั้งค่าการต่ออายุ

เทมเพลต JSON สําหรับการตั้งค่าการต่ออายุการสมัครใช้บริการ

การแสดง JSON 
{
  "renewalType": string,
  "kind": string
}
ช่อง
renewalType

string

การตั้งค่าการต่ออายุสําหรับแพ็กเกจสัญญาผูกมัดรายปี โปรดดูข้อมูลโดยละเอียดในตัวเลือกการต่ออายุในศูนย์ช่วยเหลือของผู้ดูแลระบบ เมื่อต่ออายุการสมัครใช้บริการ renewalType จะเป็นพร็อพเพอร์ตี้ที่จําเป็น
kind

string

ระบุทรัพยากรเป็นการตั้งค่าการต่ออายุการสมัครใช้บริการ ค่า: subscriptions#renewalSettings

วิธีการ

activate

 เปิดใช้งานการสมัครใช้บริการที่ระงับการใช้งานก่อนหน้านี้โดยตัวแทนจําหน่าย

changePlan

 อัปเดตแพ็กเกจการสมัครใช้บริการ

changeRenewalSettings

 อัปเดตการตั้งค่าการต่ออายุใบอนุญาตของผู้ใช้

changeSeats

 อัปเดตการตั้งค่าใบอนุญาตของผู้ใช้สําหรับการสมัครใช้บริการ

delete

 ยกเลิก ระงับ หรือโอนการสมัครใช้บริการไปยังสายตรง

get

 สมัครใช้บริการที่ต้องการ

insert

 สร้างหรือโอนการสมัครใช้บริการ

list

 รายการการสมัครใช้บริการที่จัดการโดยตัวแทนจําหน่าย

startPaidService

 ย้ายการสมัครใช้บริการแบบช่วงทดลองใช้ฟรี 30 วันไปใช้การสมัครใช้บริการที่มีค่าใช้จ่ายทันที

suspend

 ระงับการสมัครใช้บริการที่ใช้งานอยู่