target.apidocs.com.google.api.services.youtube.model.PlaylistSnippet.html Maven / Gradle / Ivy
PlaylistSnippet (YouTube Data API v3 v3-rev20240303-2.0.0)
com.google.api.services.youtube.model
Class PlaylistSnippet
- 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.PlaylistSnippet
-
public final class PlaylistSnippet
extends com.google.api.client.json.GenericJson
Basic details about a playlist, including title, description and thumbnails.
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>
-
Constructor Summary
Constructors
Constructor and Description
PlaylistSnippet()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
PlaylistSnippet
clone()
String
getChannelId()
The ID that YouTube uses to uniquely identify the channel that published the playlist.
String
getChannelTitle()
The channel title of the channel that the video belongs to.
String
getDefaultLanguage()
The language of the playlist's default title and description.
String
getDescription()
The playlist's description.
PlaylistLocalization
getLocalized()
Localized title and description, read-only.
com.google.api.client.util.DateTime
getPublishedAt()
The date and time that the playlist was created.
List<String>
getTags()
Keyword tags associated with the playlist.
ThumbnailDetails
getThumbnails()
A map of thumbnail images associated with the playlist.
String
getThumbnailVideoId()
Note: if the playlist has a custom thumbnail, this field will not be populated.
String
getTitle()
The playlist's title.
PlaylistSnippet
set(String fieldName,
Object value)
PlaylistSnippet
setChannelId(String channelId)
The ID that YouTube uses to uniquely identify the channel that published the playlist.
PlaylistSnippet
setChannelTitle(String channelTitle)
The channel title of the channel that the video belongs to.
PlaylistSnippet
setDefaultLanguage(String defaultLanguage)
The language of the playlist's default title and description.
PlaylistSnippet
setDescription(String description)
The playlist's description.
PlaylistSnippet
setLocalized(PlaylistLocalization localized)
Localized title and description, read-only.
PlaylistSnippet
setPublishedAt(com.google.api.client.util.DateTime publishedAt)
The date and time that the playlist was created.
PlaylistSnippet
setTags(List<String> tags)
Keyword tags associated with the playlist.
PlaylistSnippet
setThumbnails(ThumbnailDetails thumbnails)
A map of thumbnail images associated with the playlist.
PlaylistSnippet
setThumbnailVideoId(String thumbnailVideoId)
Note: if the playlist has a custom thumbnail, this field will not be populated.
PlaylistSnippet
setTitle(String title)
The playlist's title.
-
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
-
-
Method Detail
-
getChannelId
public String getChannelId()
The ID that YouTube uses to uniquely identify the channel that published the playlist.
- Returns:
- value or
null
for none
-
setChannelId
public PlaylistSnippet setChannelId(String channelId)
The ID that YouTube uses to uniquely identify the channel that published the playlist.
- Parameters:
channelId
- channelId or null
for none
-
getChannelTitle
public String getChannelTitle()
The channel title of the channel that the video belongs to.
- Returns:
- value or
null
for none
-
setChannelTitle
public PlaylistSnippet setChannelTitle(String channelTitle)
The channel title of the channel that the video belongs to.
- Parameters:
channelTitle
- channelTitle or null
for none
-
getDefaultLanguage
public String getDefaultLanguage()
The language of the playlist's default title and description.
- Returns:
- value or
null
for none
-
setDefaultLanguage
public PlaylistSnippet setDefaultLanguage(String defaultLanguage)
The language of the playlist's default title and description.
- Parameters:
defaultLanguage
- defaultLanguage or null
for none
-
getDescription
public String getDescription()
The playlist's description.
- Returns:
- value or
null
for none
-
setDescription
public PlaylistSnippet setDescription(String description)
The playlist's description.
- Parameters:
description
- description or null
for none
-
getLocalized
public PlaylistLocalization getLocalized()
Localized title and description, read-only.
- Returns:
- value or
null
for none
-
setLocalized
public PlaylistSnippet setLocalized(PlaylistLocalization localized)
Localized title and description, read-only.
- Parameters:
localized
- localized or null
for none
-
getPublishedAt
public com.google.api.client.util.DateTime getPublishedAt()
The date and time that the playlist was created.
- Returns:
- value or
null
for none
-
setPublishedAt
public PlaylistSnippet setPublishedAt(com.google.api.client.util.DateTime publishedAt)
The date and time that the playlist was created.
- Parameters:
publishedAt
- publishedAt or null
for none
-
getTags
public List<String> getTags()
Keyword tags associated with the playlist.
- Returns:
- value or
null
for none
-
setTags
public PlaylistSnippet setTags(List<String> tags)
Keyword tags associated with the playlist.
- Parameters:
tags
- tags or null
for none
-
getThumbnailVideoId
public String getThumbnailVideoId()
Note: if the playlist has a custom thumbnail, this field will not be populated. The video id
selected by the user that will be used as the thumbnail of this playlist. This field defaults
to the first publicly viewable video in the playlist, if: 1. The user has never selected a
video to be the thumbnail of the playlist. 2. The user selects a video to be the thumbnail, and
then removes that video from the playlist. 3. The user selects a non-owned video to be the
thumbnail, but that video becomes private, or gets deleted.
- Returns:
- value or
null
for none
-
setThumbnailVideoId
public PlaylistSnippet setThumbnailVideoId(String thumbnailVideoId)
Note: if the playlist has a custom thumbnail, this field will not be populated. The video id
selected by the user that will be used as the thumbnail of this playlist. This field defaults
to the first publicly viewable video in the playlist, if: 1. The user has never selected a
video to be the thumbnail of the playlist. 2. The user selects a video to be the thumbnail, and
then removes that video from the playlist. 3. The user selects a non-owned video to be the
thumbnail, but that video becomes private, or gets deleted.
- Parameters:
thumbnailVideoId
- thumbnailVideoId or null
for none
-
getThumbnails
public ThumbnailDetails getThumbnails()
A map of thumbnail images associated with the playlist. For each object in the map, the key is
the name of the thumbnail image, and the value is an object that contains other information
about the thumbnail.
- Returns:
- value or
null
for none
-
setThumbnails
public PlaylistSnippet setThumbnails(ThumbnailDetails thumbnails)
A map of thumbnail images associated with the playlist. For each object in the map, the key is
the name of the thumbnail image, and the value is an object that contains other information
about the thumbnail.
- Parameters:
thumbnails
- thumbnails or null
for none
-
getTitle
public String getTitle()
The playlist's title.
- Returns:
- value or
null
for none
-
setTitle
public PlaylistSnippet setTitle(String title)
The playlist's title.
- Parameters:
title
- title or null
for none
-
set
public PlaylistSnippet set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public PlaylistSnippet clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.