| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 75 | <h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.watermarks.html">watermarks</a></h1> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 78 | <code><a href="#set">set(channelId, body=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p> |
| 79 | <p class="firstline">Allows upload of watermark image and setting it for a channel.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 80 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#unset">unset(channelId, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Allows removal of channel watermark.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 85 | <code class="details" id="set">set(channelId, body=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</code> |
| 86 | <pre>Allows upload of watermark image and setting it for a channel. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 87 | |
| 88 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 89 | channelId: string, A parameter (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 90 | body: object, The request body. |
| 91 | The object takes the form of: |
| 92 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 93 | { # LINT.IfChange |
| 94 | # Describes an invideo branding. |
| 95 | "imageUrl": "A String", # The url of the uploaded image. Only used in apiary to api communication. |
| 96 | "targetChannelId": "A String", # The channel to which this branding links. If not present it defaults to |
| 97 | # the current channel. |
| 98 | "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 |
| 99 | # displayed. |
| 100 | # union of various position types, out of which only will be set one. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 101 | "type": "A String", # Defines the position type. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 102 | "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 103 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 104 | "timing": { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where watermark will be displayed. |
| 105 | "type": "A String", # Describes a timing type. If the value is <code>offsetFromStart</code>, then |
| 106 | # the <code>offsetMs</code> field represents an offset from the start of the |
| 107 | # video. If the value is <code>offsetFromEnd</code>, then the |
| 108 | # <code>offsetMs</code> field represents an offset from the end of the video. |
| 109 | "offsetMs": "A String", # Defines the time at which the promotion will appear. Depending on the value |
| 110 | # of <code>type</code> the value of the <code>offsetMs</code> field will |
| 111 | # represent a time offset from the start or from the end of the video, |
| 112 | # expressed in milliseconds. |
| 113 | "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be |
| 114 | # displayed. If missing, the client should use the default. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 115 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 116 | "imageBytes": "A String", # The bytes the uploaded image. Only used in api to youtube communication. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 117 | } |
| 118 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 119 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 120 | content partners.<br><br>The |
| 121 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 122 | that the |
| 123 | request's authorization credentials identify a YouTube CMS user who is |
| 124 | acting on behalf of the content owner specified in the parameter value. |
| 125 | This parameter is intended for YouTube content partners that own and manage |
| 126 | many different YouTube channels. It allows content owners to authenticate |
| 127 | once and get access to all their video and channel data, without having to |
| 128 | provide authentication credentials for each individual channel. The CMS |
| 129 | account that the user authenticates with must be linked to the specified |
| 130 | YouTube content owner. |
| 131 | x__xgafv: string, V1 error format. |
| 132 | Allowed values |
| 133 | 1 - v1 error format |
| 134 | 2 - v2 error format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 135 | media_body: string, The filename of the media request body, or an instance of a MediaUpload object. |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 136 | media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 137 | </pre> |
| 138 | </div> |
| 139 | |
| 140 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 141 | <code class="details" id="unset">unset(channelId, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| 142 | <pre>Allows removal of channel watermark. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 143 | |
| 144 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 145 | channelId: string, A parameter (required) |
| 146 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 147 | content partners.<br><br>The |
| 148 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 149 | that the |
| 150 | request's authorization credentials identify a YouTube CMS user who is |
| 151 | acting on behalf of the content owner specified in the parameter value. |
| 152 | This parameter is intended for YouTube content partners that own and manage |
| 153 | many different YouTube channels. It allows content owners to authenticate |
| 154 | once and get access to all their video and channel data, without having to |
| 155 | provide authentication credentials for each individual channel. The CMS |
| 156 | account that the user authenticates with must be linked to the specified |
| 157 | YouTube content owner. |
| 158 | x__xgafv: string, V1 error format. |
| 159 | Allowed values |
| 160 | 1 - v1 error format |
| 161 | 2 - v2 error format |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 162 | </pre> |
| 163 | </div> |
| 164 | |
| 165 | </body></html> |