Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 065b5307fe180bfdd4a5d9af134b1c9a0a1d2aba / . / docs / dyn / youtube_v3.channelSections.html
blob: 2b904207e2b88cc93c0cb30060b33ad2e7e70850 [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.channelSections.html">channelSections</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(id)</a></code></p>
79<p class="firstline">Deletes a channelSection.</p>
80<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]81 <code><a href="#insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Adds a channelSection for the authenticated user's channel.</p>
83<p class="toc_element">
84 <code><a href="#list">list(part=None, onBehalfOfContentOwner=None, channelId=None, mine=None, id=None)</a></code></p>
85<p class="firstline">Returns channelSection resources that match the API request criteria.</p>
86<p class="toc_element">
87 <code><a href="#update">update(part=None, body)</a></code></p>
88<p class="firstline">Update a channelSection.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(id)</code>
92 <pre>Deletes a channelSection.
93
94Args:
95 id: string, The id parameter specifies the YouTube channelSection ID for the resource that is being deleted. In a channelSection resource, the id property specifies the YouTube channelSection ID. (required)
96</pre>
97</div>
98
99<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]100 <code class="details" id="insert">insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101 <pre>Adds a channelSection for the authenticated user's channel.
102
103Args:
104 part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
105
106The part names that you can include in the parameter value are snippet and contentDetails. (required)
107 body: object, The request body. (required)
108 The object takes the form of:
109
110{ # TODO(lxz) follow up with adiamondstein@ to fullfill the doc before deploying
111 "snippet": { # Basic details about a channelsection, including title, style and position. # The snippet object contains basic details about the ChannelSection, such as its type, style and title.
112 "position": 42, # The position of the channelSection in the channel.
113 "style": "A String", # The style of the channelSection.
114 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channelSection.
115 "type": "A String", # The type of the channelSection.
116 "title": "A String", # The channelSection's title for multiple_playlists and multiple_channels.
117 },
118 "contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the ChannelSection content, such as playlists and channels.
119 "channels": [ # The channel ids for type multiple_channels.
120 "A String",
121 ],
122 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
123 "A String",
124 ],
125 },
126 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
127 "etag": "A String", # Etag of this resource.
128 "id": "A String", # The ID that YouTube uses to uniquely identify the ChannelSection.
129 }
130
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame^]131 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
132
133The 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]134 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
135
136The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
137
138This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
139
140Returns:
141 An object of the form:
142
143 { # TODO(lxz) follow up with adiamondstein@ to fullfill the doc before deploying
144 "snippet": { # Basic details about a channelsection, including title, style and position. # The snippet object contains basic details about the ChannelSection, such as its type, style and title.
145 "position": 42, # The position of the channelSection in the channel.
146 "style": "A String", # The style of the channelSection.
147 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channelSection.
148 "type": "A String", # The type of the channelSection.
149 "title": "A String", # The channelSection's title for multiple_playlists and multiple_channels.
150 },
151 "contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the ChannelSection content, such as playlists and channels.
152 "channels": [ # The channel ids for type multiple_channels.
153 "A String",
154 ],
155 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
156 "A String",
157 ],
158 },
159 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
160 "etag": "A String", # Etag of this resource.
161 "id": "A String", # The ID that YouTube uses to uniquely identify the ChannelSection.
162 }</pre>
163</div>
164
165<div class="method">
166 <code class="details" id="list">list(part=None, onBehalfOfContentOwner=None, channelId=None, mine=None, id=None)</code>
167 <pre>Returns channelSection resources that match the API request criteria.
168
169Args:
170 part: string, The part parameter specifies a comma-separated list of one or more channelSection resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails.
171
172If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channelSection resource, the snippet property contains other properties, such as a display title for the channelSection. If you set part=snippet, the API response will also contain all of those nested properties. (required)
173 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
174
175The 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.
176 channelId: string, The channelId parameter specifies a YouTube channel ID. The API will only return that channel's channelSections.
177 mine: boolean, Set this parameter's value to true to retrieve a feed of the authenticated user's channelSections.
178 id: string, The id parameter specifies a comma-separated list of the YouTube channelSection ID(s) for the resource(s) that are being retrieved. In a channelSection resource, the id property specifies the YouTube channelSection ID.
179
180Returns:
181 An object of the form:
182
183 {
184 "eventId": "A String", # Serialized EventId of the request which produced this response.
185 "items": [ # A list of ChannelSections that match the request criteria.
186 { # TODO(lxz) follow up with adiamondstein@ to fullfill the doc before deploying
187 "snippet": { # Basic details about a channelsection, including title, style and position. # The snippet object contains basic details about the ChannelSection, such as its type, style and title.
188 "position": 42, # The position of the channelSection in the channel.
189 "style": "A String", # The style of the channelSection.
190 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channelSection.
191 "type": "A String", # The type of the channelSection.
192 "title": "A String", # The channelSection's title for multiple_playlists and multiple_channels.
193 },
194 "contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the ChannelSection content, such as playlists and channels.
195 "channels": [ # The channel ids for type multiple_channels.
196 "A String",
197 ],
198 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
199 "A String",
200 ],
201 },
202 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
203 "etag": "A String", # Etag of this resource.
204 "id": "A String", # The ID that YouTube uses to uniquely identify the ChannelSection.
205 },
206 ],
207 "kind": "youtube#channelSectionListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSectionListResponse".
208 "etag": "A String", # Etag of this resource.
209 "visitorId": "A String", # The visitorId identifies the visitor.
210 }</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="update">update(part=None, body)</code>
215 <pre>Update a channelSection.
216
217Args:
218 part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
219
220The part names that you can include in the parameter value are snippet and contentDetails. (required)
221 body: object, The request body. (required)
222 The object takes the form of:
223
224{ # TODO(lxz) follow up with adiamondstein@ to fullfill the doc before deploying
225 "snippet": { # Basic details about a channelsection, including title, style and position. # The snippet object contains basic details about the ChannelSection, such as its type, style and title.
226 "position": 42, # The position of the channelSection in the channel.
227 "style": "A String", # The style of the channelSection.
228 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channelSection.
229 "type": "A String", # The type of the channelSection.
230 "title": "A String", # The channelSection's title for multiple_playlists and multiple_channels.
231 },
232 "contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the ChannelSection content, such as playlists and channels.
233 "channels": [ # The channel ids for type multiple_channels.
234 "A String",
235 ],
236 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
237 "A String",
238 ],
239 },
240 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
241 "etag": "A String", # Etag of this resource.
242 "id": "A String", # The ID that YouTube uses to uniquely identify the ChannelSection.
243 }
244
245
246Returns:
247 An object of the form:
248
249 { # TODO(lxz) follow up with adiamondstein@ to fullfill the doc before deploying
250 "snippet": { # Basic details about a channelsection, including title, style and position. # The snippet object contains basic details about the ChannelSection, such as its type, style and title.
251 "position": 42, # The position of the channelSection in the channel.
252 "style": "A String", # The style of the channelSection.
253 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that published the channelSection.
254 "type": "A String", # The type of the channelSection.
255 "title": "A String", # The channelSection's title for multiple_playlists and multiple_channels.
256 },
257 "contentDetails": { # Details about a channelsection, including playlists and channels. # The contentDetails object contains details about the ChannelSection content, such as playlists and channels.
258 "channels": [ # The channel ids for type multiple_channels.
259 "A String",
260 ],
261 "playlists": [ # The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.
262 "A String",
263 ],
264 },
265 "kind": "youtube#channelSection", # Identifies what kind of resource this is. Value: the fixed string "youtube#channelSection".
266 "etag": "A String", # Etag of this resource.
267 "id": "A String", # The ID that YouTube uses to uniquely identify the ChannelSection.
268 }</pre>
269</div>
270
271</body></html>