Set
|
|||||
|
|
||||
Uploads a watermark image to YouTube and sets it for a channel
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage your YouTube account
- See, edit, and permanently delete your YouTube videos, ratings, comments and captions
- Manage your YouTube videos
- View and manage your assets and associated content on YouTube
Input
This building block consumes 12 input parameters
| Name | Format | Description |
|---|---|---|
channelId Required |
STRING |
The channelId parameter specifies the YouTube channel ID for which the watermark is being provided |
onBehalfOfContentOwner |
STRING |
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 |
imageBytes |
BINARY |
|
imageUrl |
STRING |
|
position |
OBJECT |
Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one |
position.cornerPosition |
ENUMERATION |
Describes in which corner of the video the visual widget will appear |
position.type |
ENUMERATION |
Defines the position type |
targetChannelId |
STRING |
|
timing |
OBJECT |
Describes a temporal position of a visual widget inside a video |
timing.durationMs |
INTEGER |
Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default |
timing.offsetMs |
INTEGER |
Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds |
timing.type |
ENUMERATION |
Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video |
= Parameter name
= Format
|
channelId STRING Required The channelId parameter specifies the YouTube channel ID for which the watermark is being provided |
|
onBehalfOfContentOwner STRING 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 |
|
imageBytes BINARY |
|
imageUrl STRING |
|
position OBJECT Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one |
|
position.cornerPosition ENUMERATION Describes in which corner of the video the visual widget will appear |
|
position.type ENUMERATION Defines the position type |
|
targetChannelId STRING |
|
timing OBJECT Describes a temporal position of a visual widget inside a video |
|
timing.durationMs INTEGER Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default |
|
timing.offsetMs INTEGER Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds |
|
timing.type ENUMERATION Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video |