Wdrożenie: playlisty

Poniższe przykłady pokazują, jak korzystać z interfejsu YouTube Data API (v3) w celu wykonywania funkcji związanych z playlistami i elementami playlist.

Pobieranie playlist bieżącego użytkownika

Wywołaj metodę playlists.list, aby pobrać playlisty użytkownika, który jest obecnie uwierzytelniony. W żądaniu ustaw wartość parametru mine na true. Pamiętaj, że żądanie, które używa parametru mine, musi być autoryzowane za pomocą protokołu OAuth 2.0.

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

Pobieranie playlist użytkownika

Ten przykład pokazuje playlisty utworzone na określonym kanale. Przykład składa się z 2 kroków:

Pobieranie informacji o określonej playliście

Aby uzyskać informacje o jednej lub wielu playlistach, wywołaj metodę playlists.list i ustaw w parametrze id listę identyfikatorów playlist rozdzielonych przecinkami, które identyfikują odpowiednie zasoby. Typowym zastosowaniem użycia tej funkcji jest żądanie dodatkowych informacji na temat grupy playlist zwracanych w zestawie wyników wyszukiwania. Możesz na przykład sprawdzić, ile elementów znajduje się na każdej playliście.

Żądanie poniżej wywołuje metodę playlists.list, by pobrać liczbę elementów z 2 playlist pasujących do zapytania „GoogleDevelopers”. Ta informacja znajduje się we właściwości contentDetails.itemCount zasobu playlist, dlatego żądanie ustawia wartość parametru part na contentDetails. 

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

Dodaj playlistę

Ten przykład wywołuje metodę playlists.insert, aby utworzyć prywatną playlistę na kanale uwierzytelnionego użytkownika. Każde żądanie API do tej metody musi być autoryzowane przez OAuth 2.0.

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

Link do Eksploratora interfejsów API ustawia też parametr, który określa treść żądania do interfejsu API. Treść żądania zawiera zasób playlist, który określa informacje, takie jak tytuł, opis i stan prywatności playlisty. W tym przykładzie treść żądania:

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

Powiązane przykłady kodu: Java, JavaScript, .NET, PHP, Python

Aktualizowanie playlisty

Ten przykład aktualizuje stan prywatności playlisty z private na public. Przykład składa się z 2 kroków:

  • Krok 1. Pobierz identyfikator playlisty

    Wywołaj metodę playlist.list, aby pobierać playlisty z kanału uwierzytelnionego aktualnie użytkownika. Przykładowe żądanie powyżej służy do pobierania playlist bieżącego użytkownika. Aplikacja, która wywołuje interfejs API, może przetworzyć odpowiedź API, aby wyświetlić listę playlist, używając identyfikatora każdej z kluczy jako klucza.

  • Krok 2. Zaktualizuj playlistę

    Wywołaj metodę playlists.update, aby zmodyfikować konkretną playlistę. Ta metoda wymaga prawidłowego tokena autoryzacji OAuth 2.0.

    Treść żądania musi zawierać część snippet zasobu playlist, ponieważ przy jej wywołaniu wymagana jest właściwość snippet.title. Oprócz tego aktualizowany zasób zasobu musi określić wartości właściwości snippet.description lub snippet.tags w żądaniu aktualizacji. W przeciwnym razie zostaną one usunięte.

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

    Tak jak w powyższym przykładzie dodawania playlisty, link do Eksploratora interfejsów API ustawia parametr, który określa treść żądania do interfejsu API. Treść żądania zawiera zasób playlist, który określa informacje, takie jak tytuł, opis i stan prywatności playlisty. W tym przykładzie użyto tej treści żądania:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "public"
  }
}

    Uwaga: jeśli testujesz to zapytanie w narzędziu APIs Explorer, musisz zastąpić prawidłowy identyfikator playlisty w treści zasobu. Aby uzyskać identyfikator playlisty, najpierw uruchom żądanie widoczne powyżej, aby dodać playlistę. Wyodrębnij identyfikator playlisty z odpowiedzi interfejsu API i użyj tej wartości w przypadku playlisty, którą chcesz zaktualizować. Tytuł i opis playlisty użyte w tym przykładzie są takie same jak w tym przykładzie.

Dodaj element playlisty

Ten przykład dodaje element do playlisty. To żądanie musi zostać autoryzowane przez OAuth 2.0. Ten przykład obejmuje 2 kroki:

  • Krok 1. Pobierz odpowiedni identyfikator playlisty

    Wywołaj metodę playlist.list, aby pobierać playlisty z kanału uwierzytelnionego aktualnie użytkownika. Przykładowe żądanie powyżej służy do pobierania playlist bieżącego użytkownika. Aplikacja, która wywołuje interfejs API, może przetworzyć odpowiedź API, aby wyświetlić listę playlist, używając identyfikatora każdej z kluczy jako klucza.

  • Krok 2. Dodaj film do playlisty

    Aby dodać film do playlisty, wywołaj metodę playlistItems.insert. To żądanie musi zostać autoryzowane przez OAuth 2.0. Treść żądania to zasób playlistItem, który określa co najmniej te wartości:

    Żądanie API poniżej dodaje film do playlisty. Treść żądania to:

    {
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    }
  }
}

    Aby przesłać żądanie w Eksploratorze interfejsów API, musisz ustawić wartości właściwości snippet.playlistId i snippet.resourceId.videoId.

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

    Uwaga: informacje o innych wartościach właściwości, które możesz ustawić podczas dodawania elementu playlisty, znajdziesz w dokumentacji metody playlistItems.insert.

Aktualizowanie elementu playlisty

Ten przykład aktualizuje element playlisty tak, aby był jej pierwszym elementem. To żądanie musi zostać autoryzowane przez OAuth 2.0. Ten przykład obejmuje 3 kroki:

  • Krok 1. Pobierz odpowiedni identyfikator playlisty

    Wywołaj metodę playlist.list, aby pobierać playlisty z kanału uwierzytelnionego aktualnie użytkownika. Przykładowe żądanie powyżej służy do pobierania playlist bieżącego użytkownika. Aplikacja, która wywołuje interfejs API, może przetworzyć odpowiedź API, aby wyświetlić listę playlist, używając identyfikatora każdej z kluczy jako klucza.

  • Krok 2. Pobierz elementy z wybranej playlisty

    Wywołaj metodę playlistItems.list, aby pobrać listę filmów z wybranej playlisty. Ustaw wartość parametru playlistId na identyfikator playlisty uzyskany w kroku 1.

    Każdy zasób w odpowiedzi interfejsu API zawiera właściwość id, która jednoznacznie identyfikuje element playlisty. Użyjesz tej wartości, aby usunąć element z listy w następnym kroku.

  • Krok 3. Zaktualizuj wybrany element playlisty

    Wywołaj metodę playlistItems.update, aby zmienić pozycję filmu na playliście. Ustaw wartość parametru part na snippet. Treść żądania musi być zasobem playlistItem, który zawiera co najmniej te wartości:

    • Ustaw we właściwości id identyfikator elementu playlisty uzyskany w kroku 2.
    • Ustaw właściwość snippet.playlistId na identyfikator playlisty uzyskanej w kroku 1.
    • Ustaw właściwość snippet.resourceId.kind na youtube#video.
    • Ustaw właściwość snippet.resourceId.videoId na identyfikator filmu, który jednoznacznie identyfikuje film znajdujący się na playliście.
    • Ustaw właściwość snippet.position na 0 lub dowolną pozycję, na której ma się on pojawiać (za pomocą indeksu opartego na 0).

    Żądanie API poniżej aktualizuje element playlisty jako pierwszy. Treść żądania to:

    {
  "id": "PLAYLIST_ITEM_ID",
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    },
    "position": 0
  }
}

    Aby przesłać żądanie w Eksploratorze interfejsów API, musisz ustawić wartości właściwości id, snippet.playlistId i snippet.resourceId.videoId.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update?
        part=snippet

Usuwanie elementu playlisty

Ten przykład usuwa film z playlisty. To żądanie musi zostać autoryzowane przez OAuth 2.0. W tym przykładzie wykorzystano 3 kroki. Pierwsze dwa kroki są takie same jak w powyższym przykładzie, dotyczące aktualizowania elementu playlisty.

Po wykonaniu tych czynności wywołaj metodę playlistItems.delete, aby usunąć film z playlisty. Ustaw parametr id w żądaniu na identyfikator elementu playlisty, który chcesz usunąć. To żądanie musi zostać autoryzowane przez OAuth 2.0.

Zwróć uwagę, że ten identyfikator playlisty różni się od identyfikatora filmu w YouTube, który jednoznacznie identyfikuje dany film. Identyfikator elementu playlisty określa film jako element na tej playliście.

Aby przesłać żądanie w Eksploratorze interfejsów API, musisz ustawić wartość właściwości id.

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

Usuwanie playlisty

Ten przykład usuwa playlistę. Przykład składa się z 2 kroków:

  • Krok 1. Pobierz identyfikator playlisty

    Wywołaj metodę playlist.list, aby pobierać playlisty z kanału uwierzytelnionego aktualnie użytkownika. Przykładowe żądanie powyżej służy do pobierania playlist bieżącego użytkownika. Aplikacja, która wywołuje interfejs API, może przetworzyć odpowiedź API, aby wyświetlić listę playlist, używając identyfikatora każdej z kluczy jako klucza.

  • Krok 2. Usuń playlistę

    Aby usunąć konkretną playlistę, wywołaj metodę playlists.delete. W żądaniu parametr id określa identyfikator playlisty, którą chcesz usunąć. Ta metoda wymaga prawidłowego tokena autoryzacji OAuth 2.0. Jeśli testujesz to zapytanie w eksploratorze interfejsów API, musisz zastąpić wartość parametru id prawidłowym identyfikatorem playlisty.

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

    Uwaga: jeśli testujesz to zapytanie w Eksploratorze interfejsów API, musisz zastąpić wartość parametru id prawidłowym identyfikatorem playlisty. Aby uzyskać identyfikator playlisty, najpierw uruchom żądanie widoczne powyżej, aby dodać playlistę. Wyodrębnij identyfikator playlisty z odpowiedzi interfejsu API i użyj tej wartości w przypadku playlisty, którą chcesz usunąć.