Method: subscriptions.list

由經銷商管理的訂閱清單。這份清單可以是所有訂閱、客戶的所有訂閱，或客戶的所有可轉移訂閱。

此方法也可依 customerNamePrefix 篩選回應。詳情請參閱管理訂閱項目。

HTTP 要求

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

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

查詢參數

參數
customerAuthToken

string

當您建立經銷商帳戶，用於轉移直接客戶的訂閱，或將其他經銷商客戶的訂閱轉移給您經銷商管理時，必須使用 customerAuthToken 查詢字串。這是完成訂閱轉移所需的十六進位驗證權杖。如要瞭解詳情，請參閱管理員說明中心。
customerId

string

可以是客戶的主網域名稱或客戶的專屬 ID。如果客戶的網域名稱有所異動，舊的網域名稱無法用於存取客戶，但客戶的專屬 ID (由 API 傳回) 仍然可以使用。建議你視情況將專屬 ID 儲存在系統中。
customerNamePrefix

string

擷取所有訂閱項目及篩選出特定客戶時，您可以輸入客戶名稱的前置字元。使用包含 exam.com、example20.com 和 example.com 的範例客戶群組：

  • exa：傳回所有以「exa」開頭的客戶名稱，包括 exam.com、example20.com 和 example.com。名稱前置字串與使用規則運算式的星號 (exa)* 類似，
  • example -- 傳回 example20.com 和 example.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

詳情請參閱授權指南。