| 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 | |
| 75 | <h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.thumbnails.html">thumbnails</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 78 | <code><a href="#set">set(videoId, onBehalfOfContentOwner=None, media_body=None, media_mime_type=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 79 | <p class="firstline">Uploads a custom video thumbnail to YouTube and sets it for a video.</p> |
| 80 | <h3>Method Details</h3> |
| 81 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 82 | <code class="details" id="set">set(videoId, onBehalfOfContentOwner=None, media_body=None, media_mime_type=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <pre>Uploads a custom video thumbnail to YouTube and sets it for a video. |
| 84 | |
| 85 | Args: |
| 86 | videoId: string, The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided. (required) |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 87 | onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners. |
| 88 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 89 | 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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
| 90 | 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] | 91 | 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] | 92 | |
| 93 | Returns: |
| 94 | An object of the form: |
| 95 | |
| 96 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 97 | "etag": "A String", # Etag of this resource. |
| 98 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
| 99 | "items": [ # A list of thumbnails. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 100 | { # Internal representation of thumbnails for a YouTube resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 101 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 102 | "height": 42, # (Optional) Height of the thumbnail image. |
| 103 | "url": "A String", # The thumbnail image's URL. |
| 104 | "width": 42, # (Optional) Width of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 105 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 106 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 107 | "height": 42, # (Optional) Height of the thumbnail image. |
| 108 | "url": "A String", # The thumbnail image's URL. |
| 109 | "width": 42, # (Optional) Width of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 110 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 111 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 112 | "height": 42, # (Optional) Height of the thumbnail image. |
| 113 | "url": "A String", # The thumbnail image's URL. |
| 114 | "width": 42, # (Optional) Width of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 115 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 116 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| 117 | "height": 42, # (Optional) Height of the thumbnail image. |
| 118 | "url": "A String", # The thumbnail image's URL. |
| 119 | "width": 42, # (Optional) Width of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 120 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 121 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| 122 | "height": 42, # (Optional) Height of the thumbnail image. |
| 123 | "url": "A String", # The thumbnail image's URL. |
| 124 | "width": 42, # (Optional) Width of the thumbnail image. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 125 | }, |
| 126 | }, |
| 127 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 128 | "kind": "youtube#thumbnailSetResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#thumbnailSetResponse". |
| 129 | "visitorId": "A String", # The visitorId identifies the visitor. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 130 | }</pre> |
| 131 | </div> |
| 132 | |
| 133 | </body></html> |