YouTube Data API v3 . watermarks

Instance Methods

close()

Close httplib2 connections.

set(channelId, body=None, media_body=None, media_mime_type=None, onBehalfOfContentOwner=None, x__xgafv=None)

Allows upload of watermark image and setting it for a channel.

unset(channelId, onBehalfOfContentOwner=None, x__xgafv=None)

Allows removal of channel watermark.

Method Details

close()
Close httplib2 connections.
set(channelId, body=None, media_body=None, media_mime_type=None, onBehalfOfContentOwner=None, x__xgafv=None)
Allows upload of watermark image and setting it for a channel.

Args:
  channelId: string, A parameter (required)
  body: object, The request body.
    The object takes the form of:

{ # Describes an invideo branding.
  "imageBytes": "A String", # The bytes the uploaded image. Only used in api to youtube communication.
  "imageUrl": "A String", # The url of the uploaded image. Only used in apiary to api communication.
  "position": { # 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. # The spatial position within the video where the branding watermark will be displayed.
    "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear.
    "type": "A String", # Defines the position type.
  },
  "targetChannelId": "A String", # The channel to which this branding links. If not present it defaults to the current channel.
  "timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where watermark will be displayed.
    "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
    "offsetMs": "A String", # 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.
    "type": "A String", # 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.
  },
}

  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
unset(channelId, onBehalfOfContentOwner=None, x__xgafv=None)
Allows removal of channel watermark.

Args:
  channelId: string, A parameter (required)
  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format