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 ไปยังหน้าการสมัครใช้บริการของลูกค้าในคอนโซลผู้ดูแลระบบ บริการ 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 ดูตัวอย่างตัวแปลง 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

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

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