target.apidocs.com.google.api.services.youtube.model.Playlist.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-youtube Show documentation

There is a newer version: v3-rev20240514-2.0.0

Show newest version







Playlist (YouTube Data API v3 v3-rev20240417-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.youtube.model
Class Playlist



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.youtube.model.Playlist













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class Playlist
extends com.google.api.client.json.GenericJson
A *playlist* resource represents a YouTube playlist. A playlist is a collection of videos that
 can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos,
 and YouTube does not limit the number of playlists that each user creates. By default, playlists
 are publicly visible to other users, but playlists can be public or private. YouTube also uses
 playlists to identify special collections of videos for a channel, such as: - uploaded videos -
 favorite videos - positively rated (liked) videos - watch history - watch later To be more
 specific, these lists are associated with a channel, which is a collection of a person, group, or
 company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for
 each of these lists from the channel resource for a given channel. You can then use the
 playlistItems.list method to retrieve any of those lists. You can also add or remove items from
 those lists by calling the playlistItems.insert and playlistItems.delete methods.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the YouTube Data API v3. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


Playlist() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Playlist
clone() 


PlaylistContentDetails
getContentDetails()
The contentDetails object contains information like video count.



String
getEtag()
Etag of this resource.



String
getId()
The ID that YouTube uses to uniquely identify the playlist.



String
getKind()
Identifies what kind of resource this is.



Map<String,PlaylistLocalization>
getLocalizations()
Localizations for different languages



PlaylistPlayer
getPlayer()
The player object contains information that you would use to play the playlist in an embedded
 player.



PlaylistSnippet
getSnippet()
The snippet object contains basic details about the playlist, such as its title and
 description.



PlaylistStatus
getStatus()
The status object contains status information for the playlist.



Playlist
set(String fieldName,
   Object value) 


Playlist
setContentDetails(PlaylistContentDetails contentDetails)
The contentDetails object contains information like video count.



Playlist
setEtag(String etag)
Etag of this resource.



Playlist
setId(String id)
The ID that YouTube uses to uniquely identify the playlist.



Playlist
setKind(String kind)
Identifies what kind of resource this is.



Playlist
setLocalizations(Map<String,PlaylistLocalization> localizations)
Localizations for different languages



Playlist
setPlayer(PlaylistPlayer player)
The player object contains information that you would use to play the playlist in an embedded
 player.



Playlist
setSnippet(PlaylistSnippet snippet)
The snippet object contains basic details about the playlist, such as its title and
 description.



Playlist
setStatus(PlaylistStatus status)
The status object contains status information for the playlist.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





Playlist
public Playlist()









Method Detail





getContentDetails
public PlaylistContentDetails getContentDetails()
The contentDetails object contains information like video count.

Returns:
value or null for none








setContentDetails
public Playlist setContentDetails(PlaylistContentDetails contentDetails)
The contentDetails object contains information like video count.

Parameters:
contentDetails - contentDetails or null for none








getEtag
public String getEtag()
Etag of this resource.

Returns:
value or null for none








setEtag
public Playlist setEtag(String etag)
Etag of this resource.

Parameters:
etag - etag or null for none








getId
public String getId()
The ID that YouTube uses to uniquely identify the playlist.

Returns:
value or null for none








setId
public Playlist setId(String id)
The ID that YouTube uses to uniquely identify the playlist.

Parameters:
id - id or null for none








getKind
public String getKind()
Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".

Returns:
value or null for none








setKind
public Playlist setKind(String kind)
Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".

Parameters:
kind - kind or null for none








getLocalizations
public Map<String,PlaylistLocalization> getLocalizations()
Localizations for different languages

Returns:
value or null for none








setLocalizations
public Playlist setLocalizations(Map<String,PlaylistLocalization> localizations)
Localizations for different languages

Parameters:
localizations - localizations or null for none








getPlayer
public PlaylistPlayer getPlayer()
The player object contains information that you would use to play the playlist in an embedded
 player.

Returns:
value or null for none








setPlayer
public Playlist setPlayer(PlaylistPlayer player)
The player object contains information that you would use to play the playlist in an embedded
 player.

Parameters:
player - player or null for none








getSnippet
public PlaylistSnippet getSnippet()
The snippet object contains basic details about the playlist, such as its title and
 description.

Returns:
value or null for none








setSnippet
public Playlist setSnippet(PlaylistSnippet snippet)
The snippet object contains basic details about the playlist, such as its title and
 description.

Parameters:
snippet - snippet or null for none








getStatus
public PlaylistStatus getStatus()
The status object contains status information for the playlist.

Returns:
value or null for none








setStatus
public Playlist setStatus(PlaylistStatus status)
The status object contains status information for the playlist.

Parameters:
status - status or null for none








set
public Playlist set(String fieldName,
                    Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public Playlist clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`Playlist`	`clone()`
`PlaylistContentDetails`	`getContentDetails()` The contentDetails object contains information like video count.
`String`	`getEtag()` Etag of this resource.
`String`	`getId()` The ID that YouTube uses to uniquely identify the playlist.
`String`	`getKind()` Identifies what kind of resource this is.
`Map<String,PlaylistLocalization>`	`getLocalizations()` Localizations for different languages
`PlaylistPlayer`	`getPlayer()` The player object contains information that you would use to play the playlist in an embedded player.
`PlaylistSnippet`	`getSnippet()` The snippet object contains basic details about the playlist, such as its title and description.
`PlaylistStatus`	`getStatus()` The status object contains status information for the playlist.
`Playlist`	`set(String fieldName, Object value)`
`Playlist`	`setContentDetails(PlaylistContentDetails contentDetails)` The contentDetails object contains information like video count.
`Playlist`	`setEtag(String etag)` Etag of this resource.
`Playlist`	`setId(String id)` The ID that YouTube uses to uniquely identify the playlist.
`Playlist`	`setKind(String kind)` Identifies what kind of resource this is.
`Playlist`	`setLocalizations(Map<String,PlaylistLocalization> localizations)` Localizations for different languages
`Playlist`	`setPlayer(PlaylistPlayer player)` The player object contains information that you would use to play the playlist in an embedded player.
`Playlist`	`setSnippet(PlaylistSnippet snippet)` The snippet object contains basic details about the playlist, such as its title and description.
`Playlist`	`setStatus(PlaylistStatus status)` The status object contains status information for the playlist.