Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / youtube_v3.watermarks.html
blob: 177a01ce2164bf323d07ed7cceb7c68a4a972bb9 [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
75<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.watermarks.html">watermarks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]78 <code><a href="#set">set(channelId, body=None, media_body=None, onBehalfOfContentOwner=None, media_mime_type=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]79<p class="firstline">Uploads a watermark image to YouTube and sets it for a channel.</p>
80<p class="toc_element">
81 <code><a href="#unset">unset(channelId, onBehalfOfContentOwner=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]82<p class="firstline">Deletes a channel's watermark image.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]85 <code class="details" id="set">set(channelId, body=None, media_body=None, onBehalfOfContentOwner=None, media_mime_type=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86 <pre>Uploads a watermark image to YouTube and sets it for a channel.
87
88Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]89 channelId: string, The channelId parameter specifies the YouTube channel ID for which the watermark is being provided. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]90 body: object, The request body.
91 The object takes the form of:
92
93{
94 "targetChannelId": "A String",
95 "position": { # 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.
96 "cornerPosition": "A String", # Describes in which corner of the video the visual widget will appear.
97 "type": "A String", # Defines the position type.
98 },
99 "imageUrl": "A String",
100 "timing": { # Describes a temporal position of a visual widget inside a video.
101 "offsetMs": "A String", # 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.
102 "type": "A String", # 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.
103 "durationMs": "A String", # Defines the duration in milliseconds for which the promotion should be displayed. If missing, the client should use the default.
104 },
105 "imageBytes": "A String",
106 }
107
108 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]109 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
110
111The 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]112 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]113</pre>
114</div>
115
116<div class="method">
117 <code class="details" id="unset">unset(channelId, onBehalfOfContentOwner=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]118 <pre>Deletes a channel's watermark image.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]119
120Args:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]121 channelId: string, The channelId parameter specifies the YouTube channel ID for which the watermark is being unset. (required)
122 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
123
124The 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]125</pre>
126</div>
127
128</body></html>