Method: subscriptions.list

經銷商管理的訂閱清單。這份清單可能包含所有訂閱項目、客戶的所有訂閱,或客戶的所有可轉移訂閱。

您可以視需要使用 customerNamePrefix 篩選回應。詳情請參閱管理訂閱

HTTP 要求

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
customerAuthToken

string

建立經銷商帳戶時,您必須輸入 customerAuthToken 查詢字串,才能將直接客戶的訂閱轉移給經銷商管理。這是完成訂閱項目轉移所需的十六進位驗證權杖。如需更多資訊,請參閱管理員說明中心

customerId

string

這可以是客戶的主網域名稱或客戶的專屬 ID。如果客戶的網域名稱有所變更,舊網域名稱無法用於存取該客戶,但 API 會傳回客戶的專屬 ID (由 API 傳回)。建議您將專屬 ID 儲存在您的系統中 (如果適用)。

customerNamePrefix

string

擷取所有訂閱項目並篩選特定客戶時,您可以輸入客戶名稱的前置字串,使用包含 exam.comexample20.comexample.com 的客戶群組範例:

  • exa -- 傳回所有開頭為「exa」的客戶名稱其中包含 exam.comexample20.comexample.com。名稱前置字串與規則運算式的星號 (exa*) 類似,
  • example -- 傳回 example20.comexample.com

maxResults

integer (uint32 format)

擷取大型清單時,maxResults 是每頁的結果數量上限。nextPageToken 值會將您導向下一頁。預設值為 20。

pageToken

string

用於指定清單中下一頁的權杖

要求主體

要求主體必須為空白。

回應主體

訂閱是用來管理 Google 客戶的付款方案關係,包括產品的 SKU、使用者授權、30 天免費試用期,以及續約選項。經銷商的主要職責是管理 Google 客戶的訂閱。

如果成功,回應主體會含有以下結構的資料:

JSON 表示法
{
  "kind": string,
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
欄位
kind

string

將資源識別為訂閱項目的集合。值:reseller#subscriptions

subscriptions[]

object (Subscription)

結果頁面中的訂閱項目。

nextPageToken

string

用於逐頁瀏覽大型結果集的接續權杖。在後續要求中提供這個值,以傳回下一頁的結果。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/apps.order
  • https://www.googleapis.com/auth/apps.order.readonly

詳情請參閱授權指南