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

詳情請參閱授權指南。