REST Resource: subscriptions

Tài nguyên: Gói thuê bao

Mẫu JSON cho gói thuê bao.

Biểu diễn dưới dạng 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
  }
}
Trường
customerId

string

Thuộc tính này sẽ luôn được trả về trong phản hồi dưới dạng giá trị nhận dạng duy nhất do Google tạo. Trong một yêu cầu, thuộc tính này có thể là miền chính hoặc giá trị nhận dạng duy nhất do Google tạo.
subscriptionId

string

subscriptionId là giá trị nhận dạng gói thuê bao và là giá trị duy nhất cho mỗi khách hàng. Đây là thuộc tính bắt buộc. Vì subscriptionId thay đổi khi gói thuê bao được cập nhật, nên bạn không nên sử dụng mã nhận dạng này làm khoá cho dữ liệu ổn định. Sử dụng subscriptionId như mô tả trong phần truy xuất tất cả gói thuê bao của người bán lại.
skuId

string

Một thuộc tính bắt buộc. skuId là giá trị nhận dạng hệ thống duy nhất cho SKU của sản phẩm được chỉ định cho khách hàng trong gói thuê bao. Để biết các sản phẩm và SKU có trong phiên bản API này, hãy xem phần Mã sản phẩm và SKU.
creationTime

string (int64 format)

Thuộc tính creationTime là ngày tạo gói thuê bao. Dấu thời gian này được tính bằng mili giây theo định dạng Epoch. Xem ví dụ về Trình chuyển đổi Epoch.
kind

string

Xác định tài nguyên là Gói thuê bao. Giá trị: reseller#subscription
seats

object (Seats)

Đây là thuộc tính bắt buộc. Số lượng và giới hạn giấy phép cho số chỗ ngồi của người dùng trong gói.
renewalSettings

object (RenewalSettings)

Chế độ cài đặt gia hạn cho gói cam kết hằng năm. Để biết thêm thông tin chi tiết, hãy xem các lựa chọn gia hạn trong trung tâm trợ giúp dành cho quản trị viên.
purchaseOrderId

string

Đây là thuộc tính không bắt buộc. Thông tin đơn đặt hàng (PO) này là để người bán lại sử dụng cho mục đích theo dõi mức sử dụng của công ty. Nếu bạn cung cấp giá trị purchaseOrderId, giá trị này sẽ xuất hiện trong phản hồi API và xuất hiện trong hoá đơn. Thuộc tính này chấp nhận tối đa 80 ký tự văn bản thuần tuý.
status

string

Đây là thuộc tính không bắt buộc.
resourceUiUrl

string

URL đến trang Gói thuê bao của khách hàng trong Bảng điều khiển dành cho quản trị viên. URL chỉ có thể đọc do dịch vụ API tạo. Mã này được dùng nếu ứng dụng khách của bạn yêu cầu khách hàng hoàn tất một tác vụ bằng cách sử dụng trang Gói thuê bao trong Bảng điều khiển dành cho quản trị viên.
billingMethod

string

Trường chỉ có thể đọc trả về phương thức thanh toán hiện tại cho một gói thuê bao.
suspensionReasons[]

string

Trường chỉ có thể đọc chứa danh sách tất cả lý do tạm ngưng hiện tại của một gói thuê bao. Một gói thuê bao có thể có nhiều lý do tạm ngưng trùng lặp và đồng thời. STATUS của gói thuê bao là SUSPENDED cho đến khi tất cả các quyết định tạm ngưng đang chờ xử lý bị xoá.

Các lựa chọn có thể bao gồm:

  • PENDING_TOS_ACCEPTANCE – Khách hàng chưa đăng nhập và chấp nhận Điều khoản dịch vụ của G Suite được bán lại.
  • RENEWAL_WITH_TYPE_CANCEL – Cam kết của khách hàng đã kết thúc và dịch vụ của họ đã bị huỷ khi hết hạn.
  • RESELLER_INITIATED – Lệnh tạm ngưng theo hình thức thủ công do Đại lý thực hiện.
  • TRIAL_ENDED – Thời gian dùng thử của khách hàng đã hết hạn mà không chọn gói nào.
  • OTHER – Khách hàng bị tạm ngưng vì lý do nội bộ của Google (ví dụ: hành vi sai trái hoặc lý do khác).

customerDomain

string

Tên miền chính của khách hàng
dealCode

string

Mã do Google phát hành (tối đa 100 ký tự) để giảm giá cho các gói thuê bao. Bạn phải thêm mã ưu đãi vào các yêu cầu insert để nhận được mức giá chiết khấu. Thuộc tính này là không bắt buộc, giá thông thường sẽ áp dụng nếu bạn để trống.
skuName

string

Tên hiển thị bên ngoài chỉ có thể đọc cho SKU của sản phẩm được chỉ định cho khách hàng trong gói thuê bao. Tên SKU có thể thay đổi theo quyết định của Google. Để biết các sản phẩm và SKU có trong phiên bản API này, hãy xem phần Mã sản phẩm và SKU.
plan

object

Thuộc tính plan là bắt buộc. Trong phiên bản API này, các gói G Suite là gói linh hoạt, gói cam kết hằng năm và gói dùng thử miễn phí 30 ngày. Để biết thêm thông tin về các gói thanh toán của API, hãy xem các khái niệm về API.
plan.planName

string

Thuộc tính planName là bắt buộc. Đây là tên của gói thuê bao. Để biết thêm thông tin về các gói thanh toán của Google, hãy xem các khái niệm về API.

Các giá trị có thể có là:

  • ANNUAL_MONTHLY_PAY – Gói cam kết hằng năm với khoản thanh toán hằng tháng.
  • ANNUAL_YEARLY_PAY – Gói cam kết hằng năm với phương thức thanh toán hằng năm
  • FLEXIBLE – Gói linh hoạt
  • TRIAL – Gói dùng thử miễn phí trong 30 ngày. Gói thuê bao đang dùng thử sẽ bị tạm ngưng sau ngày miễn phí thứ 30 nếu bạn không chỉ định gói thanh toán. Việc gọi changePlan sẽ chỉ định một gói thanh toán cho gói dùng thử nhưng sẽ không kích hoạt gói đó. Gói dùng thử sẽ tự động bắt đầu gói thanh toán được chỉ định sau ngày miễn phí thứ 30 hoặc ngay sau khi gọi startPaidService.
  • FREE – Gói miễn phí dành riêng cho SKU Cloud Identity và không tính phí.

plan.isCommitmentPlan

boolean

Giá trị boolean của thuộc tính isCommitmentPlan xác định gói này là gói cam kết hằng năm:

  • true – Gói thuê bao là gói cam kết hằng năm.
  • false – Gói này không phải là gói cam kết hằng năm.
plan.commitmentInterval

object

Trong phiên bản API này, khoảng thời gian của gói cam kết hằng năm là một năm.

plan.commitmentInterval.startTime

string (int64 format)

startTime của khoảng thời gian của kế hoạch cam kết hằng năm tính bằng mili giây theo định dạng UNIX Epoch. Xem ví dụ về Trình chuyển đổi Epoch.
plan.commitmentInterval.endTime

string (int64 format)

endTime của khoảng thời gian của kế hoạch cam kết hằng năm tính bằng mili giây theo định dạng UNIX Epoch. Xem ví dụ về Trình chuyển đổi Epoch.
trialSettings

object

G Suite có gói thanh toán linh hoạt và gói cam kết hằng năm. Bạn có thể dùng thử gói cam kết hằng năm trong 30 ngày. Để biết thêm thông tin, hãy xem Các khái niệm về API.
trialSettings.isInTrial

boolean

Xác định xem gói thuê bao có đang trong thời gian dùng thử miễn phí 30 ngày hay không:

  • true – Gói đang trong thời gian dùng thử.
  • false – Gói không đang trong thời gian dùng thử.
trialSettings.trialEndTime

string (int64 format)

Ngày kết thúc thời gian dùng thử. Giá trị được tính bằng mili giây theo định dạng UNIX Epoch. Xem ví dụ về Trình chuyển đổi Epoch.
transferInfo

object

Thông tin liên quan đến việc chuyển gói thuê bao ở chế độ chỉ có thể đọc. Để biết thêm thông tin, hãy xem phần truy xuất các gói thuê bao có thể chuyển cho khách hàng.
transferInfo.transferabilityExpirationTime

string (int64 format)

Thời điểm mã chuyển hoặc ý định chuyển sẽ hết hạn. Thời gian được tính bằng mili giây theo định dạng Unix Epoch.
transferInfo.minimumTransferableSeats

integer

Khi chèn gói thuê bao, đây là số lượng chỗ ngồi tối thiểu được liệt kê trong đơn đặt hàng chuyển đổi cho sản phẩm này. Ví dụ: nếu khách hàng có 20 người dùng, thì đại lý không thể đặt đơn đặt hàng chuyển 15 chỗ ngồi. Số lượng tối thiểu là 20 chỗ.
transferInfo.currentLegacySkuId

string

skuId của gói thuê bao được bán lại hiện tại. Giá trị này chỉ được điền khi khách hàng có gói thuê bao với SKU cũ và tài nguyên gói thuê bao được điền bằng skuId của SKU được đề xuất để chuyển.

Ghế ngồi

Mẫu JSON cho số chỗ ngồi theo gói thuê bao.

Biểu diễn dưới dạng JSON 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
Trường
numberOfSeats

integer

Đây là thuộc tính bắt buộc và dành riêng cho các gói thuê bao ANNUAL_MONTHLY_PAY và ANNUAL_YEARLY_PAY. Thuộc tính này đặt số lượng giấy phép tối đa có thể chỉ định cho người dùng trên một gói thuê bao. Đại lý có thể thêm nhiều giấy phép hơn, nhưng sau khi đặt, bạn không thể giảm numberOfSeats cho đến khi gia hạn. Người bán lại sẽ được lập hoá đơn dựa trên giá trị numberOfSeats, bất kể số lượng giấy phép người dùng được chỉ định là bao nhiêu.

maximumNumberOfSeats

integer

Đây là thuộc tính bắt buộc và dành riêng cho các gói thuê bao có gói FLEXIBLE hoặc TRIAL. Thuộc tính này đặt số lượng người dùng được cấp phép tối đa được phép trên một gói thuê bao. Số lượng này có thể tăng lên đến hạn mức tối đa được xác định trong hợp đồng của đại lý. Số lượng tối thiểu là số người dùng hiện tại trong tài khoản khách hàng.

licensedNumberOfSeats

integer

Trường chỉ có thể đọc chứa số lượng người dùng hiện tại được chỉ định giấy phép cho sản phẩm được xác định trong skuId. Giá trị của trường này tương đương với số lượng người dùng do phương thức Enterprise License Manager API trả về: listForProductAndSku.
kind

string

Xác định tài nguyên là chế độ cài đặt chỗ ngồi của gói thuê bao. Giá trị: subscriptions#seats

RenewalSettings

Mẫu JSON cho chế độ cài đặt gia hạn gói thuê bao.

Biểu diễn dưới dạng JSON 
{
  "renewalType": string,
  "kind": string
}
Trường
renewalType

string

Chế độ cài đặt gia hạn cho gói cam kết hằng năm. Để biết thêm thông tin chi tiết, hãy xem các lựa chọn gia hạn trong trung tâm trợ giúp dành cho quản trị viên. Khi gia hạn gói thuê bao, renewalType là thuộc tính bắt buộc.
kind

string

Xác định tài nguyên là chế độ cài đặt gia hạn gói thuê bao. Giá trị: subscriptions#renewalSettings

Phương thức

activate

 Kích hoạt gói thuê bao mà đại lý đã tạm ngưng trước đó.

changePlan

 Cập nhật gói thuê bao.

changeRenewalSettings

 Cập nhật chế độ cài đặt gia hạn của giấy phép người dùng.

changeSeats

 Cập nhật chế độ cài đặt giấy phép của người dùng cho gói thuê bao.

delete

 Huỷ, tạm ngưng hoặc chuyển một gói thuê bao sang trực tiếp.

get

 Lấy một gói thuê bao cụ thể.

insert

 Tạo hoặc chuyển gói thuê bao.

list

 Danh sách các gói thuê bao do đại lý quản lý.

startPaidService

 Chuyển ngay gói thuê bao dùng thử miễn phí trong 30 ngày sang gói thuê bao dịch vụ có tính phí.

suspend

 Tạm ngưng một gói thuê bao đang hoạt động.