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 ดูตัวอย่างเครื่องมือแปลงยุค
kind

string

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

object (Seats)

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

object (RenewalSettings)

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

string

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

string

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

string

URL ไปยังหน้าการสมัครใช้บริการของลูกค้าในคอนโซลผู้ดูแลระบบ บริการ API จะสร้าง URL แบบอ่านอย่างเดียว จะใช้ในกรณีที่แอปพลิเคชันไคลเอ็นต์กำหนดให้ลูกค้าทำงานให้เสร็จโดยใช้หน้าการสมัครใช้บริการในคอนโซลผู้ดูแลระบบ
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 — แพ็กเกจฟรีมีไว้สำหรับ SKU ของ Cloud Identity โดยเฉพาะและไม่มีการเรียกเก็บเงิน

plan.isCommitmentPlan

boolean

ค่าบูลีนพร็อพเพอร์ตี้ isCommitmentPlan จะระบุแพ็กเกจว่าเป็นแพ็กเกจที่ต้องชำระเงินตามสัญญารายปี

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

object

ใน API เวอร์ชันนี้ ช่วงเวลาของแพ็กเกจผูกมัดรายปีคือ 1 ปี

plan.commitmentInterval.startTime

string (int64 format)

startTime ของช่วงเวลาในแพ็กเกจความมุ่งมั่นรายปีเป็นมิลลิวินาทีโดยใช้รูปแบบ UNIX Epoch ดูตัวอย่างเครื่องมือแปลงยุค
plan.commitmentInterval.endTime

string (int64 format)

endTime ของช่วงเวลาในแผนความมุ่งมั่นรายปีเป็นมิลลิวินาทีโดยใช้รูปแบบ UNIX Epoch ดูตัวอย่างเครื่องมือแปลงยุค
trialSettings

object

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

boolean

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

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

string (int64 format)

วันที่สิ้นสุดช่วงทดลองใช้ ค่าเป็นมิลลิวินาทีโดยใช้รูปแบบ UNIX 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

RenewalSettings

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

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

string

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

string

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

เมธอด

activate

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

changePlan

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

changeRenewalSettings

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

changeSeats

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

delete

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

get

 รับการสมัครใช้บริการที่เฉพาะเจาะจง

insert

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

list

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

startPaidService

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

suspend

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