Watermarks

Page Summary

• A watermark resource displays an image during a channel's video playbacks, with the option to link to a target channel.

• The API provides set and unset methods to upload and delete watermark images respectively.

• The timing object controls when a watermark appears, using type to determine if it's measured from the start or end of a video and offsetMs for the time offset, with durationMs defining its display length.

• The position object defines the watermark's location within the video, with cornerPosition specifically determining the corner.

• The targetChannelId property is used to indicate the YouTube channel ID that the image links to when interacted with.

A watermark resource identifies an image that displays during playbacks of a specified channel's videos. You can also specify a target channel to which the image will link as well as timing details that determine when the watermark appears during video playbacks and the length of time it is visible.

Methods

The API supports the following methods for watermarks resources:

set

Uploads a watermark image to YouTube and sets it for a channel.

unset

Deletes a channel's watermark image. Try it now.

Resource representation

The JSON structure below shows the format of a watermarks resource:

{
  "timing": {
    "type": string,
    "offsetMs": unsigned long,
    "durationMs": unsigned long
  },
  "position": {
    "type": string,
    "cornerPosition": string
  },
  "imageUrl": string,
  "imageBytes": bytes,
  "targetChannelId": string
}

Properties

The following table defines the properties that appear in this resource:

Properties
timing	object The timing object encapsulates information about the time during a video playback when a channel's watermark image will display. This object is required when calling watermarks.set.
timing.type	string The timing method that determines when the watermark image is displayed during the video playback. This property is required when calling watermarks.set. Valid values are: offsetFromStart: The offsetMs field represents an offset from the start of the video. offsetFromEnd: The offsetMs field represents an offset from the end of the video.
timing.offsetMs	unsigned long The time offset, specified in milliseconds, that determines when the promoted item appears during video playbacks. This property is required when calling watermarks.set. When type is offsetFromEnd, offsetMs must be at least 1000 milliseconds.
timing.durationMs	unsigned long The length of time, in milliseconds, that the watermark image should display. This property is optional. If specified, the minimum duration is 1000 milliseconds. When type is offsetFromEnd, durationMs must not exceed offsetMs.
position	object Deprecated: The position object is deprecated and ignored by YouTube. Watermarks always display in the upper right corner of the video player.
imageUrl	string The URL for the channel's watermark image. YouTube will generate this URL and return it in the API response to a watermark.set request.
imageBytes	bytes The size of the watermark image, in bytes.
targetChannelId	string The YouTube channel ID of the channel that the watermark image links to.