Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 80558ac428fc4d7ab058f251e2e47ed029afaf01 / . / docs / dyn / youtube_v3.watermarks.html
blob: 2c053dd83eb6bb6ad3a49a0aa093ae91ec159968 [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.watermarks.html">watermarks</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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]81 <code><a href="#set">set(channelId, body=None, media_body=None, media_mime_type=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]82<p class="firstline">Allows upload of watermark image and setting it for a channel.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#unset">unset(channelId, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Allows removal of channel watermark.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]93 <code class="details" id="set">set(channelId, body=None, media_body=None, media_mime_type=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]94 <pre>Allows upload of watermark image and setting it for a channel.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]95
96Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]97 channelId: string, A parameter (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98 body: object, The request body.
99 The object takes the form of:
100
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]101{ # LINT.IfChange Describes an invideo branding.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]102 &quot;imageBytes&quot;: &quot;A String&quot;, # The bytes the uploaded image. Only used in api to youtube communication.
103 &quot;imageUrl&quot;: &quot;A String&quot;, # The url of the uploaded image. Only used in apiary to api communication.
104 &quot;position&quot;: { # Describes the spatial position of a visual widget inside a video. It is a union of various position types, out of which only will be set one. # The spatial position within the video where the branding watermark will be displayed.
105 &quot;cornerPosition&quot;: &quot;A String&quot;, # Describes in which corner of the video the visual widget will appear.
106 &quot;type&quot;: &quot;A String&quot;, # Defines the position type.
107 },
108 &quot;targetChannelId&quot;: &quot;A String&quot;, # The channel to which this branding links. If not present it defaults to the current channel.
109 &quot;timing&quot;: { # Describes a temporal position of a visual widget inside a video. # The temporal position within the video where watermark will be displayed.
110 &quot;durationMs&quot;: &quot;A String&quot;, # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
111 &quot;offsetMs&quot;: &quot;A String&quot;, # Defines the time at which the promotion will appear. Depending on the value of type the value of the offsetMs field will represent a time offset from the start or from the end of the video, expressed in milliseconds.
112 &quot;type&quot;: &quot;A String&quot;, # Describes a timing type. If the value is offsetFromStart, then the offsetMs field represents an offset from the start of the video. If the value is offsetFromEnd, then the offsetMs field represents an offset from the end of the video.
113 },
114}
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]115
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]116 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
117 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118 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 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]119 x__xgafv: string, V1 error format.
120 Allowed values
121 1 - v1 error format
122 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]123</pre>
124</div>
125
126<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]127 <code class="details" id="unset">unset(channelId, onBehalfOfContentOwner=None, x__xgafv=None)</code>
128 <pre>Allows removal of channel watermark.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]129
130Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]131 channelId: string, A parameter (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]132 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 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]133 x__xgafv: string, V1 error format.
134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]137</pre>
138</div>
139
140</body></html>