Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Modifies a playlist item. For example, you could update the item's position in the playlist.
See: YouTube Data API Reference for youtube.playlistItems.update
.
Synopsis
- type PlayListItemsUpdateResource = "youtube" :> ("v3" :> ("playlistItems" :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] PlayListItem :> Put '[JSON] PlayListItem))))))
- playListItemsUpdate :: Text -> PlayListItem -> PlayListItemsUpdate
- data PlayListItemsUpdate
- pliuPart :: Lens' PlayListItemsUpdate Text
- pliuPayload :: Lens' PlayListItemsUpdate PlayListItem
- pliuOnBehalfOfContentOwner :: Lens' PlayListItemsUpdate (Maybe Text)
REST Resource
type PlayListItemsUpdateResource = "youtube" :> ("v3" :> ("playlistItems" :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] PlayListItem :> Put '[JSON] PlayListItem)))))) Source #
A resource alias for youtube.playlistItems.update
method which the
PlayListItemsUpdate
request conforms to.
Creating a Request
Creates a value of PlayListItemsUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data PlayListItemsUpdate Source #
Modifies a playlist item. For example, you could update the item's position in the playlist.
See: playListItemsUpdate
smart constructor.
Instances
Request Lenses
pliuPart :: Lens' PlayListItemsUpdate Text Source #
The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a playlist item can specify a start time and end time, which identify the times portion of the video that should play when users watch the video in the playlist. If your request is updating a playlist item that sets these values, and the request's part parameter value includes the contentDetails part, the playlist item's start and end times will be updated to whatever value the request body specifies. If the request body does not specify values, the existing start and end times will be removed and replaced with the default settings.
pliuPayload :: Lens' PlayListItemsUpdate PlayListItem Source #
Multipart request metadata.
pliuOnBehalfOfContentOwner :: Lens' PlayListItemsUpdate (Maybe Text) Source #
Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.