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

導入：播放清單

下列範例說明如何使用 YouTube Data API (v3) 執行與播放清單和播放清單項目相關的功能。

擷取目前使用者的播放清單

呼叫 playlists.list 方法以擷取目前驗證使用者的播放清單。在要求中，將 mine 參數的值設為 true。請注意，使用 mine 參數的要求必須採用 OAuth 2.0 授權。

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=snippet,contentDetails
        &mine=true

擷取使用者的播放清單

這個範例會擷取特定頻道建立的播放清單。這個範例有兩個步驟：

步驟 1：擷取頻道 ID

呼叫 channels.list 方法，即可擷取與特定 YouTube 使用者名稱相關聯的頻道 ID。(在此範例中，使用者名稱為 GoogleDevelopers)。在 API 回應中，id 屬性可用來識別頻道 ID。
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.channels.list?
        part=id
        &forUsername=GoogleDevelopers
```

步驟 2：擷取頻道的播放清單

呼叫 playlists.list 方法以擷取頻道的播放清單。將 channelId 參數的值設為步驟 1 中取得的值。

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=snippet,contentDetails
        &channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw

擷取特定播放清單的資訊

如要擷取一或多個特定播放清單的相關資訊，請呼叫 playlists.list 方法，並將 id 參數設為以半形逗號分隔的 YouTube 播放清單 ID 清單，用於識別所需資源。這項功能的常見用途，是要求針對一組搜尋結果所傳回的播放清單群組擷取額外資訊。舉例來說，您可能想要擷取每個播放清單中的項目數量。

以下要求會呼叫 playlists.list 方法，擷取兩個播放清單中符合查詢字詞「GoogleDevelopers」的商品數量。這項資訊位於 playlist 資源的 contentDetails.itemCount 屬性中，因此要求會將 part 參數值設為 contentDetails。

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=contentDetails
        &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w

新增播放清單

這個範例會呼叫 playlists.insert 方法，在已驗證使用者的頻道中建立私人播放清單。這個方法的所有 API 要求，都必須使用 OAuth 2.0 授權。

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert?
        part=snippet,status

API Explorer 的連結也會設定用來指定 API 要求主體的參數。要求主體包含 playlist 資源，用於定義播放清單的標題、說明和隱私權狀態等資訊。在這個範例中，要求主體為：

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "private"
  }
}

以下範例會將新的播放清單標示為 Podcast 節目：

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

相關程式碼範例：Java、JavaScript、.NET、PHP、Python

更新播放清單

這個範例會將播放清單的隱私設定從 private 更新為 public。這個範例有兩個步驟：

步驟 1：擷取播放清單 ID

呼叫 playlists.list 方法，擷取目前已驗證使用者頻道上的播放清單。以上要求範例說明如何擷取目前使用者的播放清單。呼叫 API 的應用程式可以處理 API 回應，使用每個播放清單的 ID 做為索引鍵，以顯示播放清單清單。
步驟 2：更新播放清單

呼叫 playlists.update 方法即可修改特定播放清單。這個方法需要有效的 OAuth 2.0 授權權杖。

要求主體必須包含 playlist 資源的 snippet 部分，因為呼叫此方法時必須提供 snippet.title 屬性。此外，如果要更新的播放清單資源指定 snippet.description 或 snippet.tags 屬性的值，則必須在更新要求中重新指定這些值，否則會予以刪除。
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update?
        part=snippet,status
```
與上述新增播放清單的範例一樣，API Explorer 連結會設定參數來指定 API 要求的主體。要求主體包含 playlist 資源，用於定義播放清單的標題、說明和隱私權狀態等資訊。這個範例所用的要求主體如下：
```
{
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "public"
  }
}
```
以下範例會將播放清單標示為 Podcast 節目：
```
{
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}
```
注意：如果您在 APIs Explorer 中測試這項查詢，必須在資源主體中取代有效的播放清單 ID。如要取得播放清單 ID，建議您先執行上述新增播放清單的要求。從 API 回應中擷取播放清單 ID，然後用於要更新的播放清單。這個範例中使用的播放清單標題和說明，與這個範例中的名稱和說明相同。

新增播放清單項目

這個範例會將項目新增至播放清單。這個請求必須使用 OAuth 2.0 授權。這個範例有兩個步驟：

步驟 1：擷取適當的播放清單 ID

呼叫 playlists.list 方法，擷取目前已驗證使用者頻道上的播放清單。以上要求範例說明如何擷取目前使用者的播放清單。呼叫 API 的應用程式可以處理 API 回應，使用每個播放清單的 ID 做為索引鍵，以顯示播放清單清單。
步驟 2：將影片新增至播放清單

呼叫 playlistItems.insert 方法，將影片新增至播放清單。這個請求必須使用 OAuth 2.0 授權。要求主體是 playlistItem 資源，其至少指定下列值：
- snippet.playlistId 可識別您要新增影片的播放清單。這是您在步驟 1 中取得的播放清單 ID。
- snippet.resourceId.kind 包含 youtube#video 值。
- snippet.resourceId.videoId 可識別您要新增到播放清單的影片。屬性值是不重複的 YouTube 影片 ID。
下方的 API 要求會將影片新增至播放清單。要求主體如下：
```
{
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    }
  }
}
```
如要在 API Explorer 中完成要求，您必須設定 snippet.playlistId 和 snippet.resourceId.videoId 屬性的值。
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert?
        part=snippet
```
注意：playlistItems.insert 方法的說明文件會說明新增播放清單項目時，可以設定的其他屬性值。

新增播放清單圖片

您可以使用第 3 版 API 的 playlistImages.insert 方法上傳自訂縮圖，並將其設為播放清單。在要求中，playlistId 參數的值會指明要使用縮圖的播放清單。

API Explorer 不支援上傳媒體檔案的功能，因此無法使用 APIs Explorer 測試這項查詢。

更新播放清單項目

這個範例會更新播放清單項目，使其成為播放清單中的第一個項目。這個請求必須使用 OAuth 2.0 授權。這個範例包含三個步驟：

步驟 1：擷取適當的播放清單 ID

呼叫 playlists.list 方法，擷取目前已驗證使用者頻道上的播放清單。以上要求範例說明如何擷取目前使用者的播放清單。呼叫 API 的應用程式可以處理 API 回應，使用每個播放清單的 ID 做為索引鍵，以顯示播放清單清單。
步驟 2：擷取所選播放清單中的商品

呼叫 playlistItems.list 方法，擷取所選播放清單中的影片清單。將 playlistId 參數的值設為您在步驟 1 中取得的播放清單 ID。

API 回應中的每個資源都包含一個 id 屬性，用以識別該商品的播放清單項目 ID。在下一個步驟中，您將使用該值從清單中移除項目。
步驟 3：更新選取的播放清單項目

呼叫 playlistItems.update 方法即可變更影片在播放清單中的位置。將 part 參數值設為 snippet。要求主體必須是 playlistItem 資源，且至少要設定下列值：
- 將 id 屬性設為在步驟 2 中取得的播放清單項目 ID。
- 將 snippet.playlistId 屬性設為在步驟 1 中取得的播放清單 ID。
- 將 snippet.resourceId.kind 屬性設為 youtube#video。
- 將 snippet.resourceId.videoId 屬性設定為影片 ID，用來識別播放清單中的影片。
- 將 snippet.position 屬性設為 0，或設為項目顯示的位置 (使用從 0 開始的索引)。
下方的 API 要求會將播放清單項目更新為播放清單中的第一個項目。要求主體如下：
```
{
  "id": "PLAYLIST_ITEM_ID",
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    },
    "position": 0
  }
}
```
如要在 APIs Explorer 中完成要求，您必須設定 id、snippet.playlistId 和 snippet.resourceId.videoId 屬性的值。
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update?
        part=snippet
```

更新播放清單圖片

您可以使用 v3 API 的 playlistImages.update 方法更新播放清單的縮圖。在要求中，playlistId 參數的值會指明要使用縮圖的播放清單。

API Explorer 不支援上傳媒體檔案的功能，因此無法使用 APIs Explorer 測試這項查詢。

移除播放清單項目

這個範例會從播放清單中刪除影片。這個請求必須使用 OAuth 2.0 授權。此範例包含三個步驟前兩個步驟與上述更新播放清單項目範例相同。

完成這些步驟後，請呼叫 playlistItems.delete 方法，以便從播放清單中移除影片。將要求的 id 參數設為要移除的項目的播放清單項目 ID。這個請求必須使用 OAuth 2.0 授權。

請注意，用於識別播放清單中影片的播放清單項目 ID，與用來識別影片的專屬 YouTube 影片 ID 並不相同。播放清單項目 ID 可用來識別影片在特定播放清單中的項目。

如要在 APIs Explorer 中完成要求，請設定 id 屬性的值。

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete?
        id=PLAYLIST_ITEM_ID

移除播放清單圖片

這個範例會刪除播放清單圖片。這個範例有兩個步驟：

步驟 1：擷取播放清單

呼叫 playlists.list 方法，擷取目前已驗證使用者頻道上的播放清單。以上要求範例說明如何擷取目前使用者的播放清單。呼叫 API 的應用程式可以處理 API 回應，使用每個播放清單的 ID 做為索引鍵，以顯示播放清單清單。
步驟 2：擷取播放清單圖片 ID

呼叫 playlistImages.list 方法，擷取播放清單的縮圖。使用要變更播放清單的播放清單 ID。
步驟 3：刪除播放清單圖片

呼叫 playlistImages.delete 方法即可刪除特定的播放清單圖片。在要求中，id 參數會指定要刪除的播放清單圖片 ID。這個方法需要有效的 OAuth 2.0 授權權杖。如果您在 APIs Explorer 中測試這項查詢，就必須將 id 參數值換成有效的播放清單 ID。
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistImages.delete?
        id=ID
```
注意：如果您在 APIs Explorer 中測試這項查詢，就必須將 id 參數值換成有效的播放清單圖片 ID。

移除播放清單

這個範例會刪除播放清單。這個範例有兩個步驟：

步驟 1：擷取播放清單 ID

呼叫 playlists.list 方法，擷取目前已驗證使用者頻道上的播放清單。以上要求範例說明如何擷取目前使用者的播放清單。呼叫 API 的應用程式可以處理 API 回應，使用每個播放清單的 ID 做為索引鍵，以顯示播放清單清單。
步驟 2：刪除播放清單

呼叫 playlists.delete 方法即可刪除特定播放清單。在要求中，id 參數會指定要刪除的播放清單 ID。這個方法需要有效的 OAuth 2.0 授權權杖。如果您在 APIs Explorer 中測試這項查詢，就必須將 id 參數值換成有效的播放清單 ID。
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete?
        id=PLAYLIST_ID
```
注意：如果您在 APIs Explorer 中測試這項查詢，就必須將 id 參數值換成有效的播放清單 ID。如要取得播放清單 ID，建議您先執行上述新增播放清單的要求。從 API 回應中擷取播放清單 ID，然後用於要刪除的播放清單。