blob: bc5a5c36f69fd1d6fe7e8c0123d870fbe67ef874 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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 Kimd059ad82020-07-22 17:02:09 -070075<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.thumbnails.html">thumbnails</a></h1>
John Asmuth614db982014-04-24 15:46:26 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070078 <code><a href="#set">set(videoId, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
79<p class="firstline">As this is not an insert in a strict sense (it supports uploading/setting</p>
John Asmuth614db982014-04-24 15:46:26 -040080<h3>Method Details</h3>
81<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070082 <code class="details" id="set">set(videoId, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
83 <pre>As this is not an insert in a strict sense (it supports uploading/setting
84of a thumbnail for multiple videos, which doesn&#x27;t result in creation of a
85single resource), I use a custom verb here.
John Asmuth614db982014-04-24 15:46:26 -040086
87Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -070088 videoId: string, Returns the Thumbnail with the given video IDs for Stubby or Apiary. (required)
89 onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
90content partners.&lt;br&gt;&lt;br&gt;The
91&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; parameter indicates
92that the
93request&#x27;s authorization credentials identify a YouTube CMS user who is
94acting on behalf of the content owner specified in the parameter value.
95This parameter is intended for YouTube content partners that own and manage
96many different YouTube channels. It allows content owners to authenticate
97once and get access to all their video and channel data, without having to
98provide authentication credentials for each individual channel. The actual
99CMS account that the user authenticates with must be linked to the
100specified YouTube content owner.
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700105 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800106 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
John Asmuth614db982014-04-24 15:46:26 -0400107
108Returns:
109 An object of the form:
110
111 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700112 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
113 &quot;items&quot;: [ # A list of thumbnails.
John Asmuth614db982014-04-24 15:46:26 -0400114 { # Internal representation of thumbnails for a YouTube resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700115 &quot;medium&quot;: { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700116 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700117 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
118 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
John Asmuth614db982014-04-24 15:46:26 -0400119 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700120 &quot;standard&quot;: { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700121 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700122 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
123 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
124 },
125 &quot;default&quot;: { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
126 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
127 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
128 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
129 },
130 &quot;maxres&quot;: { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
131 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
132 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
133 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
134 },
135 &quot;high&quot;: { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
136 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
137 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
138 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
John Asmuth614db982014-04-24 15:46:26 -0400139 },
140 },
141 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700142 &quot;visitorId&quot;: &quot;A String&quot;, # The &lt;code&gt;visitorId&lt;/code&gt; identifies the visitor.
143 &quot;kind&quot;: &quot;youtube#thumbnailSetResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string
144 # &lt;code&gt;&quot;youtube#thumbnailSetResponse&quot;&lt;/code&gt;.
145 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
John Asmuth614db982014-04-24 15:46:26 -0400146 }</pre>
147</div>
148
149</body></html>