本頁面由 Cloud Translation API 翻譯而成。

Subscriptions: list

傳回符合 API 要求條件的訂閱資源。

配額影響：呼叫這個方法的配額為 1 個單位。

常見用途

要求

HTTP 要求

GET https://www.googleapis.com/youtube/v3/subscriptions

參數

下表列出此查詢支援的參數。這裡列出的參數全都是查詢參數。

參數
必要參數
`part`	`string` `part` 參數會指定一份以半形逗號分隔的清單，列出一或多個 API 回應會包含的 `subscription` 資源屬性。如果參數識別含有子屬性的屬性，則回應中會加入這些子項屬性。舉例來說，在 `subscription` 資源中，`snippet` 屬性包含其他屬性，例如訂閱項目的顯示標題。如果設定 `part=snippet`，API 回應也會包含所有巢狀屬性。以下清單包含您可以加入參數值中的 `part` 名稱： `contentDetails` `id` `snippet` `subscriberSnippet`
篩選器 (請僅指定下列其中一個參數)
`channelId`	`string` `channelId` 參數會指定 YouTube 頻道 ID。API 只會傳回該頻道的訂閱項目。
`id`	`string` `id` 參數會指定待擷取資源的 YouTube 訂閱 ID 清單 (以半形逗號分隔)。在 `subscription` 資源中，`id` 屬性會指定 YouTube 訂閱 ID。
`mine`	`boolean` 這個參數只能在正確的授權要求中使用。將這個參數的值設為 `true`，即可擷取已驗證使用者訂閱項目的動態消息。
`myRecentSubscribers`	`boolean` 這個參數只能在正確的授權要求中使用。將這個參數的值設為 `true`，即可依反向時間順序 (由新到舊) 擷取已驗證使用者訂閱者的動態消息。請注意，透過這個 API 傳回的訂閱者數量上限可能有限。
`mySubscribers`	`boolean` 這個參數只能在正確的授權要求中使用。將這個參數的值設為 `true`，即可擷取已驗證使用者訂閱者的動態消息 (順序不限)。請注意，透過這個 API 傳回的訂閱者數量上限可能會受到限制。
選用參數
`forChannelId`	`string` `forChannelId` 參數會指定以半形逗號分隔的頻道 ID 清單。如此一來，API 回應就會只包含與這些頻道相符的訂閱項目。
`maxResults`	`unsigned integer` `maxResults` 參數會指定結果集應傳回的項目數量上限。可接受的值為 `0` 到 `50` (含頭尾)。預設值為 `5`。
`onBehalfOfContentOwner`	`string` 注意：這個參數僅適用於 YouTube 內容合作夥伴。 `onBehalfOfContentOwner` 參數代表用於要求的授權憑證，代表 YouTube CMS 使用者，代表在參數值中指定的內容擁有者代表行事。這個參數適用於擁有及管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。內容擁有者只要通過一次驗證，即可存取所有影片和頻道資料，不必分別提供各個頻道的驗證憑證。用於驗證的 CMS 帳戶，必須連結至指定的 YouTube 內容擁有者。
`onBehalfOfContentOwnerChannel`	`string` 這個參數只能在正確的授權要求中使用。注意：這個參數僅適用於 YouTube 內容合作夥伴。 `onBehalfOfContentOwnerChannel` 參數會指定待加入影片的 YouTube 頻道 ID。如果要求指定 `onBehalfOfContentOwner` 參數值，就必須指定這個參數，且只能搭配該參數使用。此外，該要求都必須使用與 `onBehalfOfContentOwner` 參數指定的內容擁有者相連結的 CMS 帳戶進行授權。最後，`onBehalfOfContentOwnerChannel` 參數值指定的頻道必須與 `onBehalfOfContentOwner` 參數指定的內容擁有者相連結。這個參數適用於擁有及管理多個不同 YouTube 頻道的 YouTube 內容合作夥伴。有了這項功能，內容擁有者只需驗證一次，就能代表參數值中指定的頻道執行動作，不必為每個頻道提供驗證憑證。
`order`	`string` `order` 參數會指定用於排序 API 回應資源的方法。預設值為 `SUBSCRIPTION_ORDER_RELEVANCE`。可接受的值如下： `alphabetical`：按照字母順序排列。 `relevance`：依關聯性排序。 `unread`：依活動順序排序。
`pageToken`	`string` `pageToken` 參數可在結果集中指明應傳回的特定網頁。在 API 回應中，`nextPageToken` 和 `prevPageToken` 屬性會識別其他可擷取的網頁。

要求主體

呼叫此方法時，不要提供要求主體。

回應

如果成功的話，這個方法會傳回回應內文，其結構如下：

{
  "kind": "youtube#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription Resource
  ]
}

屬性

下表定義了這項資源中顯示的屬性：

屬性
`kind`	`string` 識別 API 資源的類型。值為 `youtube#subscriptionListResponse`。
`etag`	`etag` 這項資源的 Etag。
`nextPageToken`	`string` 可做為 `pageToken` 參數值的權杖，用於擷取結果集中的下一頁。
`prevPageToken`	`string` 可做為 `pageToken` 參數值的權杖，擷取結果集中的上一頁。
`pageInfo`	`object` `pageInfo` 物件會封裝結果集的分頁資訊。
`pageInfo.totalResults`	`integer` 結果集的結果總數。
`pageInfo.resultsPerPage`	`integer` API 回應中包含的結果數量。
`items[]`	`list` 符合要求條件的訂閱項目清單。

錯誤

下表列出 API 回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息的說明文件。

錯誤類型	錯誤詳細資料	說明
`forbidden (403)`	`accountClosed`	無法擷取訂閱項目，因為訂閱者的帳戶已關閉。
`forbidden (403)`	`accountSuspended`	訂閱者的帳戶已遭停權，因此無法擷取訂閱項目。
`forbidden (403)`	`subscriptionForbidden`	要求者無法存取所要求的訂閱項目。
`notFound (404)`	`subscriberNotFound`	找不到要求所識別的訂閱者。

試試看！

使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。