Implementacja: playlisty

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

Pobierz playlisty bieżącego użytkownika

Wywołaj metodę playlists.list, aby pobrać playlisty obecnie uwierzytelnionego użytkownika. W żądaniu ustaw wartość parametru mine na true. Żądanie korzystające z 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 pobiera playlisty utworzone na konkretnym kanale. Przykład składa się z 2 etapów:

Pobieranie informacji o konkretnej playliście

Aby uzyskać informacje o jednej lub kilku konkretnych playlistach, wywołaj metodę playlists.list, a dla parametru id podaj oddzieloną przecinkami listę identyfikatorów playlist YouTube identyfikujących odpowiednie zasoby. Częstym zastosowaniem tej funkcji jest żądanie pobrania dodatkowych 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.

Poniższe żądanie wywołuje metodę playlists.list, aby pobrać liczbę elementów z dwóch playlist, które pasują do zapytania „GoogleDevelopers”. Ta informacja znajduje się we 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

Dodaj playlistę

W tym przykładzie wywołujemy metodę playlists.insert, która tworzy prywatną playlistę na kanale uwierzytelnionego użytkownika. Wszelkie żądania interfejsu API wysyłane do tej metody muszą być autoryzowane za pomocą protokołu 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 takie informacje 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"
  }
}

Podobne przykłady kodu: Java, JavaScript, .NET, PHP i Python

Aktualizowanie playlisty

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

  • Krok 1. Pobierz identyfikator playlisty

    Wywołaj metodę playlists.list, aby pobrać playlisty z kanału obecnie uwierzytelnionego użytkownika. Przykładowe żądanie pobrania playlist bieżącego użytkownika powyżej. Aplikacja wywołująca interfejs API może przetworzyć odpowiedź tego interfejsu i wyświetlić listę playlist, używając identyfikatora każdej playlisty jako klucza.

  • Krok 2. Aktualizowanie playlisty

    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 wywoływaniu tej metody wymagana jest właściwość snippet.title. Dodatkowo, jeśli aktualizowany zasób playlisty zawiera wartości właściwości snippet.description lub snippet.tags, wartości te muszą zostać ponownie określone 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, gdy dodajesz playlistę, 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 takie informacje jak tytuł, opis i stan prywatności playlisty. W tym przykładzie używana jest następująca treść żądania:

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

    W tym przykładzie playlista jest oznaczona jako podcast:

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

    Uwaga: jeśli testujesz to zapytanie w narzędziu APIs Explorer, w treści zasobu musisz wstawić prawidłowy identyfikator playlisty. Aby uzyskać identyfikator playlisty, najlepiej najpierw uruchom podane wyżej żądanie dodania playlisty. 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 są takie same jak w tym przykładzie.

Dodaj element playlisty

Ten przykład pozwala dodać element do playlisty. To żądanie musi być autoryzowane za pomocą protokołu OAuth 2.0. Ten przykład składa się z 2 etapów:

  • Krok 1. Uzyskaj odpowiedni identyfikator playlisty

    Wywołaj metodę playlists.list, aby pobrać playlisty z kanału obecnie uwierzytelnionego użytkownika. Przykładowe żądanie pobrania playlist bieżącego użytkownika powyżej. Aplikacja wywołująca interfejs API może przetworzyć odpowiedź tego interfejsu i wyświetlić listę playlist, używając identyfikatora każdej playlisty jako klucza.

  • Krok 2. Dodaj film do playlisty

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

    • snippet.playlistId identyfikuje playlistę, do której dodajesz film. Jest to identyfikator playlisty uzyskany w kroku 1.
    • snippet.resourceId.kind zawiera wartość youtube#video.
    • Identyfikator snippet.resourceId.videoId wskazuje film, który dodajesz do playlisty. Wartością właściwości jest unikalny identyfikator filmu w YouTube.

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

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

    Aby wykonać żądanie w narzędziu 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: w dokumentacji metody playlistItems.insert wymienione są inne wartości właściwości, które możesz ustawić przy dodawaniu elementu playlisty.

Dodaj obraz playlisty

Za pomocą metody playlistImages.insert interfejsu API w wersji 3 możesz przesłać niestandardowy obraz miniatury i ustawić go dla playlisty. Wartość parametru playlistId w żądaniu wskazuje playlistę, na której zostanie użyta miniatura.

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

Aktualizowanie elementu playlisty

Ten przykład aktualizuje element playlisty tak, aby był jej pierwszy. To żądanie musi być autoryzowane za pomocą protokołu OAuth 2.0. Ten przykład składa się z 3 etapów:

  • Krok 1. Uzyskaj odpowiedni identyfikator playlisty

    Wywołaj metodę playlists.list, aby pobrać playlisty z kanału obecnie uwierzytelnionego użytkownika. Przykładowe żądanie pobrania playlist bieżącego użytkownika powyżej. Aplikacja wywołująca interfejs API może przetworzyć odpowiedź tego interfejsu i wyświetlić listę playlist, używając identyfikatora każdej playlisty jako klucza.

  • Krok 2. Pobierz elementy z wybranej playlisty

    Wywołaj metodę playlistItems.list, aby pobrać listę filmów z wybranej playlisty. Jako wartość parametru playlistId ustaw 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. Użyjesz tej wartości do usunięcia elementu 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 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 znajdujący się na playliście.
    • Ustaw właściwość snippet.position na 0 lub na dowolną pozycję, na której element ma się pojawić (indeksując od 0).

    Poniższe żądanie do interfejsu API aktualizuje element playlisty tak, aby stał się jej pierwszym elementem. Treść żądania to:

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

    Aby wykonać żądanie w narzędziu APIs Explorer, 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

Do aktualizowania miniatury playlisty możesz użyć metody playlistImages.update interfejsu API w wersji 3. Wartość parametru playlistId w żądaniu wskazuje playlistę, na której zostanie użyta miniatura.

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

Usuwanie elementu playlisty

Ten przykład pozwala usunąć film z playlisty. To żądanie musi być autoryzowane za pomocą protokołu OAuth 2.0. Ten przykład składa się z 3 etapów. Pierwsze dwa kroki są takie same jak opisane powyżej w przypadku aktualizacji elementu playlisty.

Po wykonaniu tych czynności wywołaj metodę playlistItems.delete, aby usunąć film z playlisty. Ustaw parametr id żądania na identyfikator elementu playlisty, który chcesz usunąć. To żądanie musi być autoryzowane za pomocą protokołu OAuth 2.0.

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

Aby wykonać żądanie w narzędziu 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

Ten przykład pozwala usunąć obraz playlisty. Przykład składa się z 2 etapów:

  • Krok 1. Pobierz playlistę

    Wywołaj metodę playlists.list, aby pobrać playlisty z kanału obecnie uwierzytelnionego użytkownika. Przykładowe żądanie pobrania playlist bieżącego użytkownika powyżej. Aplikacja wywołująca interfejs API może przetworzyć odpowiedź tego interfejsu i wyświetlić listę playlist, używając identyfikatora każdej playlisty jako klucza.

  • Krok 2. Pobierz identyfikator obrazu playlisty

    Wywołaj metodę playlistImages.list, aby pobrać obraz miniatury playlisty. Użyj identyfikatora playlisty, którą chcesz zmienić.

  • Krok 3. Usuń obraz playlisty

    Wywołaj metodę playlistImages.delete, aby usunąć określony obraz playlisty. Parametr id w żądaniu określa identyfikator usuwanego obrazu playlisty. Ta metoda wymaga prawidłowego tokena autoryzacji OAuth 2.0. Jeśli testujesz to zapytanie w narzędziu APIs 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 Eksploratorze interfejsów API, musisz zastąpić wartość parametru id prawidłowym identyfikatorem obrazu playlisty.

Usuwanie playlisty

Ten przykład pozwala usunąć playlistę. Przykład składa się z 2 etapów:

  • Krok 1. Pobierz identyfikator playlisty

    Wywołaj metodę playlists.list, aby pobrać playlisty z kanału obecnie uwierzytelnionego użytkownika. Przykładowe żądanie pobrania playlist bieżącego użytkownika powyżej. Aplikacja wywołująca interfejs API może przetworzyć odpowiedź tego interfejsu i wyświetlić listę playlist, używając identyfikatora każdej playlisty jako klucza.

  • Krok 2. Usuń playlistę

    Aby usunąć konkretną playlistę, wywołaj metodę playlists.delete. Parametr id w żądaniu określa identyfikator usuniętej playlisty. Ta metoda wymaga prawidłowego tokena autoryzacji OAuth 2.0. Jeśli testujesz to zapytanie w narzędziu APIs 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 Eksploratorze interfejsów API, musisz zastąpić wartość parametru id prawidłowym identyfikatorem playlisty. Aby uzyskać identyfikator playlisty, najlepiej najpierw uruchom podane wyżej żądanie dodania playlisty. Wyodrębnij identyfikator playlisty z odpowiedzi interfejsu API i użyj tej wartości w przypadku playlisty, którą chcesz usunąć.