Implementacja: playlisty

Poniższe przykłady pokazują, jak używać interfejsu YouTube Data API (w wersji 3) do wykonywania funkcji związanych z playlistami i elementami playlisty.

Pobieranie playlist bieżącego użytkownika

Aby pobrać playlisty aktualnie uwierzytelnionego użytkownika, wywołaj metodę playlists.list. W prośbie ustaw wartość parametru mine na true. Pamiętaj, że żądanie, które używa parametru mine, musi być autoryzowane za pomocą 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 zwraca playlisty utworzone przez konkretny kanał. Przykład składa się z 2 etapów:

Pobieranie informacji o konkretnej playliście

Aby pobrać informacje o jednej lub większej liczbie konkretnych playlist, wywołaj metodę playlists.list i ustaw parametr id jako listę rozdzielonych przecinkami identyfikatorów playlist w YouTube, które identyfikują żądane zasoby. Typowym zastosowaniem tej funkcji jest żądanie dodatkowej informacji o grupie playlist zwróconych w zestawie wyników wyszukiwania. Możesz na przykład pobrać liczbę elementów na każdej playliście.

Prośba poniżej wywołuje metodę playlists.list, aby pobrać liczbę elementów na 2 listach odtwarzania, które pasują do zapytania „GoogleDevelopers”. Te informacje znajdują się w właściwości contentDetails.itemCount zasobu playlist, więc żądanie ustawia wartość parametru part na contentDetails. 

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

Dodawanie playlisty

W tym przykładzie wywołujemy metodę playlists.insert, aby utworzyć prywatną playlistę na kanale uwierzytelnionego użytkownika. Każde żądanie interfejsu API wysyłane tą metodą musi być autoryzowane za pomocą OAuth 2.0.

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

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

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

W tym przykładzie nowa playlista jest oznaczona jako podcast:

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

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

Aktualizowanie playlisty

W tym przykładzie stan prywatności playlisty zmienia się z private na public. Przykład składa się z 2 etapów:

  • Krok 1. Pobierz identyfikator playlisty

    Aby pobrać playlisty z kanału aktualnie uwierzytelnionego użytkownika, wywołaj metodę playlists.list. Przykładowe żądanie pobierania playlist bieżącego użytkownika to dobry przykład. Aplikacja wywołująca interfejs API może przetworzyć odpowiedź interfejsu API, aby wyświetlić listę playlist, używając identyfikatora każdej playlisty jako klucza.

  • Krok 2. Aktualizowanie playlisty

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

    Treść żądania musi zawierać część snippet zasobu playlist, ponieważ podczas wywoływania tej metody wymagana jest właściwość snippet.title. Jeśli aktualizowany zasób playlisty zawiera wartości właściwości snippet.description lub snippet.tags, musisz je ponownie podać w żądaniu aktualizacji, w przeciwnym razie zostaną usunięte.

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

    W przykładzie powyżej dotyczącym dodawania playlisty link do narzędzia API Explorer ustawia parametr, który określa treść żądania do interfejsu API. Treść żądania zawiera zasób playlist, który definiuje 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"
  }
}

    W tym przykładzie playlista jest oznaczona jako program podcastu:

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

    Uwaga: jeśli testujesz to zapytanie w narzędzie API Explorer, musisz podać prawidłowy identyfikator playlisty w ciele zasobu. Aby uzyskać identyfikator playlisty, zalecamy najpierw wykonanie pokazanego powyżej żądania dotyczącego dodawania playlisty. Wyodrębnij identyfikator playlisty z odpowiedzi interfejsu API i użyj tej wartości dla playlisty, którą chcesz zaktualizować. Tytuł i opis playlisty użyte w tym przykładzie są takie same jak w przykładzie.

Dodawanie elementu do playlisty

W tym przykładzie element jest dodawany do playlisty. To żądanie musi być autoryzowane za pomocą OAuth 2.0. W tym przykładzie należy wykonać 2 kroki:

  • Krok 1. Pobierz odpowiedni identyfikator playlisty

    Aby pobrać playlisty z kanału aktualnie uwierzytelnionego użytkownika, wywołaj metodę playlists.list. Przykładowe żądanie powyżej dotyczące pobierania playlist bieżącego użytkownika to przykład takiego żądania. Aplikacja wywołująca interfejs API może przetworzyć odpowiedź interfejsu API, aby wyświetlić listę playlist, używając identyfikatora każdej playlisty jako klucza.

  • Krok 2. Dodaj film do playlisty

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

    Poniższe żądanie interfejsu API dodaje film do playlisty. Treść żądania:

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

    Aby przesłać żądanie w narzędzie APIs Explorer, 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: dokumentacja metody playlistItems.insert zawiera inne wartości właściwości, które możesz ustawić podczas dodawania elementu playlisty.

Dodawanie obrazu playlisty

Aby przesłać niestandardową miniaturę i ustawić ją na playliście, możesz użyć metody playlistImages.insert interfejsu API w wersji 3. W żądaniu wartość parametru playlistId wskazuje playlistę, której miniatura ma być używana.

Nie można przetestować tego zapytania za pomocą narzędzia APIs Explorer, ponieważ nie obsługuje ono przesyłania plików multimedialnych, co jest wymagane w przypadku tej metody.

Aktualizowanie elementu na playliście

W tym przykładzie element playlisty jest aktualizowany, aby stał się pierwszym elementem na liście. To żądanie musi być autoryzowane za pomocą OAuth 2.0. Ten przykład składa się z 3 etapów:

  • Krok 1. Pobierz odpowiedni identyfikator playlisty

    Aby pobrać playlisty z kanału aktualnie uwierzytelnionego użytkownika, wywołaj metodę playlists.list. Przykładowe żądanie powyżej dotyczące pobierania playlist bieżącego użytkownika to przykład takiego żądania. Aplikacja wywołująca interfejs API może przetworzyć odpowiedź interfejsu API, aby wyświetlić listę playlist, używając identyfikatora każdej playlisty jako klucza.

  • Krok 2. Pobierz elementy z wybranej playlisty

    Aby pobrać listę filmów na wybranej playliście, wywołaj metodę playlistItems.list. 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 identyfikuje identyfikator elementu playlisty, który jednoznacznie identyfikuje ten element. W następnym kroku użyjesz tej wartości, aby usunąć element z listy.

  • Krok 3. Zaktualizuj wybrany element playlisty

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

    • Ustaw właściwość id na identyfikator elementu playlisty uzyskany w kroku 2.
    • Ustaw właściwość snippet.playlistId na identyfikator playlisty uzyskany 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 zawarty na playliście.
    • Ustaw właściwość snippet.position na 0 lub na dowolną pozycję, na której ma się pojawić element (używając indeksu od 0).

    Poniższe żądanie interfejsu API aktualizuje element playlisty, aby był pierwszym elementem na liście. Treść żądania:

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

    Aby przesłać żądanie w poruszniku 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

Aktualizowanie obrazu playlisty

Aby zaktualizować miniaturę playlisty, możesz użyć metody playlistImages.update interfejsu API w wersji 3. W żądaniu wartość parametru playlistId wskazuje playlistę, której miniatura ma być używana.

Nie można przetestować tego zapytania za pomocą narzędzia APIs Explorer, ponieważ nie obsługuje ono przesyłania plików multimedialnych, co jest wymagane w przypadku tej metody.

Usuwanie elementu z playlisty

W tym przykładzie film jest usuwany z playlisty. To żądanie musi być autoryzowane za pomocą OAuth 2.0. W tym przykładzie są 3 kroki. Pierwsze 2 kroki są takie same jak w przypadku aktualizowania elementu na playliście.

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 być autoryzowane za pomocą OAuth 2.0.

Pamiętaj, że identyfikator elementu playlisty służący do identyfikacji filmu na playliście jest inny niż identyfikator filmu w YouTube, który jednoznacznie identyfikuje film. Identyfikator elementu playlisty identyfikuje film jako element na konkretnej playliście.

Aby przesłać żądanie w interfejsie APIs Explorer, 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 obrazu playlisty

W tym przykładzie usuwamy obraz z playlisty. Przykład składa się z 2 etapów:

  • Krok 1. Pobierz playlistę

    Aby pobrać playlisty z kanału aktualnie uwierzytelnionego użytkownika, wywołaj metodę playlists.list. Przykładowe żądanie pobierania playlist bieżącego użytkownika to dobry przykład. Aplikacja wywołująca interfejs API może przetworzyć odpowiedź interfejsu API, aby wyświetlić listę playlist, używając identyfikatora każdej playlisty jako klucza.

  • Krok 2. Pobierz identyfikator obrazu playlisty

    Aby pobrać miniaturę playlisty, wywołaj metodę playlistImages.list. Użyj identyfikatora playlisty, którą chcesz zmienić.

  • Krok 3. Usuwanie obrazu playlisty

    Aby usunąć konkretny obraz playlisty, wywołaj metodę playlistImages.delete. W żądaniu parametr id określa identyfikator obrazu playlisty, który ma zostać usunięty. Ta metoda wymaga prawidłowego tokena autoryzacji OAuth 2.0. Jeśli testujesz to zapytanie w narzędzie API Explorer, musisz zastąpić wartość parametru id prawidłowym identyfikatorem playlisty.

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

    Uwaga: jeśli testujesz to zapytanie w narzędziu APIs Explorer, musisz zastąpić wartość parametru id prawidłowym identyfikatorem obrazu playlisty.

Usuwanie playlisty

W tym przykładzie usuwamy playlistę. Przykład składa się z 2 etapów:

  • Krok 1. Pobierz identyfikator playlisty

    Aby pobrać playlisty z kanału aktualnie uwierzytelnionego użytkownika, wywołaj metodę playlists.list. Przykładowe żądanie powyżej dotyczące pobierania playlist bieżącego użytkownika to przykład takiego żądania. Aplikacja wywołująca interfejs API może przetworzyć odpowiedź interfejsu API, aby wyświetlić listę playlist, używając identyfikatora każdej playlisty jako klucza.

  • Krok 2. Usuwanie playlisty

    Aby usunąć konkretną playlistę, wywołaj metodę playlists.delete. W żądaniu parametr id określa identyfikator playlisty, która ma zostać usunięta. Ta metoda wymaga prawidłowego tokena autoryzacji OAuth 2.0. Jeśli testujesz to zapytanie w narzędzie API Explorer, 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 narzędziu APIs Explorer, musisz zastąpić wartość parametru id prawidłowym identyfikatorem listy odtwarzania. Aby uzyskać identyfikator playlisty, zalecamy najpierw wykonanie pokazanego powyżej żądania dotyczącego dodawania playlisty. Wyodrębnij identyfikator playlisty z odpowiedzi interfejsu API i użyj tej wartości dla playlisty, którą chcesz usunąć.