target.apidocs.com.google.api.services.youtube.model.PlaylistItem.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







PlaylistItem (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 PlaylistItem



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.PlaylistItem













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




public final class PlaylistItem
extends com.google.api.client.json.GenericJson
A *playlistItem* resource identifies another resource, such as a video, that is included in a
 playlist. In addition, the playlistItem resource contains details about the included resource
 that pertain specifically to how that resource is used in that playlist. YouTube 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. For example, if
 a user gives a positive rating to a video, you would insert that video into the liked videos
 playlist for that user's channel.

  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


PlaylistItem() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


PlaylistItem
clone() 


PlaylistItemContentDetails
getContentDetails()
The contentDetails object is included in the resource if the included item is a YouTube video.



String
getEtag()
Etag of this resource.



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



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



PlaylistItemSnippet
getSnippet()
The snippet object contains basic details about the playlist item, such as its title and
 position in the playlist.



PlaylistItemStatus
getStatus()
The status object contains information about the playlist item's privacy status.



PlaylistItem
set(String fieldName,
   Object value) 


PlaylistItem
setContentDetails(PlaylistItemContentDetails contentDetails)
The contentDetails object is included in the resource if the included item is a YouTube video.



PlaylistItem
setEtag(String etag)
Etag of this resource.



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



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



PlaylistItem
setSnippet(PlaylistItemSnippet snippet)
The snippet object contains basic details about the playlist item, such as its title and
 position in the playlist.



PlaylistItem
setStatus(PlaylistItemStatus status)
The status object contains information about the playlist item's privacy status.







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





PlaylistItem
public PlaylistItem()









Method Detail





getContentDetails
public PlaylistItemContentDetails getContentDetails()
The contentDetails object is included in the resource if the included item is a YouTube video.
 The object contains additional information about the video.

Returns:
value or null for none








setContentDetails
public PlaylistItem setContentDetails(PlaylistItemContentDetails contentDetails)
The contentDetails object is included in the resource if the included item is a YouTube video.
 The object contains additional information about the video.

Parameters:
contentDetails - contentDetails or null for none








getEtag
public String getEtag()
Etag of this resource.

Returns:
value or null for none








setEtag
public PlaylistItem 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 item.

Returns:
value or null for none








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

Parameters:
id - id or null for none








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

Returns:
value or null for none








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

Parameters:
kind - kind or null for none








getSnippet
public PlaylistItemSnippet getSnippet()
The snippet object contains basic details about the playlist item, such as its title and
 position in the playlist.

Returns:
value or null for none








setSnippet
public PlaylistItem setSnippet(PlaylistItemSnippet snippet)
The snippet object contains basic details about the playlist item, such as its title and
 position in the playlist.

Parameters:
snippet - snippet or null for none








getStatus
public PlaylistItemStatus getStatus()
The status object contains information about the playlist item's privacy status.

Returns:
value or null for none








setStatus
public PlaylistItem setStatus(PlaylistItemStatus status)
The status object contains information about the playlist item's privacy status.

Parameters:
status - status or null for none








set
public PlaylistItem set(String fieldName,
                        Object value)

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








clone
public PlaylistItem 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
`PlaylistItem`	`clone()`
`PlaylistItemContentDetails`	`getContentDetails()` The contentDetails object is included in the resource if the included item is a YouTube video.
`String`	`getEtag()` Etag of this resource.
`String`	`getId()` The ID that YouTube uses to uniquely identify the playlist item.
`String`	`getKind()` Identifies what kind of resource this is.
`PlaylistItemSnippet`	`getSnippet()` The snippet object contains basic details about the playlist item, such as its title and position in the playlist.
`PlaylistItemStatus`	`getStatus()` The status object contains information about the playlist item's privacy status.
`PlaylistItem`	`set(String fieldName, Object value)`
`PlaylistItem`	`setContentDetails(PlaylistItemContentDetails contentDetails)` The contentDetails object is included in the resource if the included item is a YouTube video.
`PlaylistItem`	`setEtag(String etag)` Etag of this resource.
`PlaylistItem`	`setId(String id)` The ID that YouTube uses to uniquely identify the playlist item.
`PlaylistItem`	`setKind(String kind)` Identifies what kind of resource this is.
`PlaylistItem`	`setSnippet(PlaylistItemSnippet snippet)` The snippet object contains basic details about the playlist item, such as its title and position in the playlist.
`PlaylistItem`	`setStatus(PlaylistItemStatus status)` The status object contains information about the playlist item's privacy status.