Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / youtube_v3.thumbnails.html
blob: 8dedd94a6cda3456ebd5e3a9e67468d1e33487d2 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<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 -0700[diff] [blame]75<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 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#set">set(videoId, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]82<p class="firstline">As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn't result in creation of a single resource), I use a custom verb here.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90 <code class="details" id="set">set(videoId, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]91 <pre>As this is not an insert in a strict sense (it supports uploading/setting of a thumbnail for multiple videos, which doesn&#x27;t result in creation of a single resource), I use a custom verb here.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92
93Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]94 videoId: string, Returns the Thumbnail with the given video IDs for Stubby or Apiary. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]95 onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request&#x27;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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]96 x__xgafv: string, V1 error format.
97 Allowed values
98 1 - v1 error format
99 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]100 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 -0800[diff] [blame]101 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 -0400[diff] [blame]102
103Returns:
104 An object of the form:
105
106 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 &quot;items&quot;: [ # A list of thumbnails.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]108 { # Internal representation of thumbnails for a YouTube resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]109 &quot;default&quot;: { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]110 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]111 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]112 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
113 },
114 &quot;maxres&quot;: { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]115 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]116 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
117 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
118 },
119 &quot;medium&quot;: { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
120 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
121 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
122 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
123 },
124 &quot;standard&quot;: { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
125 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
126 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]127 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
128 },
129 &quot;high&quot;: { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]130 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]131 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]132 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]133 },
134 },
135 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]136 &quot;visitorId&quot;: &quot;A String&quot;, # The visitorId identifies the visitor.
137 &quot;kind&quot;: &quot;youtube#thumbnailSetResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#thumbnailSetResponse&quot;.
138 &quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]139 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]140 }</pre>
141</div>
142
143</body></html>