| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.watermarks.html">watermarks</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#set">set(channelId, body=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p> |
| <p class="firstline">Allows upload of watermark image and setting it for a channel.</p> |
| <p class="toc_element"> |
| <code><a href="#unset">unset(channelId, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Allows removal of channel watermark.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="set">set(channelId, body=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</code> |
| <pre>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: |
| |
| { # LINT.IfChange |
| # Describes an invideo branding. |
| "imageUrl": "A String", # The url of the uploaded image. Only used in apiary to api communication. |
| "targetChannelId": "A String", # The channel to which this branding links. If not present it defaults to |
| # the current channel. |
| "position": { # Describes the spatial position of a visual widget inside a video. It is a # The spatial position within the video where the branding watermark will be |
| # displayed. |
| # union of various position types, out of which only will be set one. |
| "type": "A String", # Defines the position type. |
| "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear. |
| }, |
| "timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where watermark will be displayed. |
| "type": "A String", # Describes a timing type. If the value is <code>offsetFromStart</code>, then |
| # the <code>offsetMs</code> field represents an offset from the start of the |
| # video. If the value is <code>offsetFromEnd</code>, then the |
| # <code>offsetMs</code> field represents an offset from the end of the video. |
| "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value |
| # of <code>type</code> the value of the <code>offsetMs</code> field will |
| # represent a time offset from the start or from the end of the video, |
| # expressed in milliseconds. |
| "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be |
| # displayed. If missing, the client should use the default. |
| }, |
| "imageBytes": "A String", # The bytes the uploaded image. Only used in api to youtube communication. |
| } |
| |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> 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 |
| 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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="unset">unset(channelId, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| <pre>Allows removal of channel watermark. |
| |
| Args: |
| channelId: string, A parameter (required) |
| onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| content partners.<br><br>The |
| <code><strong>onBehalfOfContentOwner</strong></code> 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 |
| </pre> |
| </div> |
| |
| </body></html> |
