Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / youtube_v3.subscriptions.html
blob: c385962079fe5a4adc26d296e42c8fe92600e224 [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.subscriptions.html">subscriptions</a></h1>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]78 <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a resource.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]81 <code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Inserts a new resource into this collection.</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="#list">list(part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, mine=None, channelId=None, forChannelId=None, order=None, id=None, mySubscribers=None, myRecentSubscribers=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]91 <code class="details" id="delete">delete(id, x__xgafv=None)</code>
92 <pre>Deletes a resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]93
94Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]95 id: string, A parameter (required)
96 x__xgafv: string, V1 error format.
97 Allowed values
98 1 - v1 error format
99 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]100</pre>
101</div>
102
103<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]104 <code class="details" id="insert">insert(part, body=None, x__xgafv=None)</code>
105 <pre>Inserts a new resource into this collection.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]106
107Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]108 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter serves two purposes in
109this operation. It identifies the properties that the write operation will
110set as well as the properties that the API response will include. (required) (repeated)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]111 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]112 The object takes the form of:
113
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]114{ # A &lt;code&gt;&lt;strong&gt;subscription&lt;/strong&gt;&lt;/code&gt; resource contains information
115 # about a YouTube user subscription. A subscription notifies a user when new
116 # videos are added to a channel or when another user takes one of several
117 # actions on YouTube, such as uploading a video, rating a video, or commenting
118 # on a video.
119 &quot;snippet&quot;: { # Basic details about a subscription, including title, description and # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the
120 # subscription, including its title and the channel that the user subscribed
121 # to.
122 # thumbnails of the subscribed item.
123 &quot;title&quot;: &quot;A String&quot;, # The subscription&#x27;s title.
124 &quot;channelTitle&quot;: &quot;A String&quot;, # Channel title for the channel that the subscription belongs to.
125 &quot;resourceId&quot;: { # A resource id is a generic reference that points to another YouTube resource. # The &lt;code&gt;id&lt;/code&gt; object contains information about the channel that
126 # the user subscribed to.
127 &quot;kind&quot;: &quot;A String&quot;, # The type of the API resource.
128 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the referred resource, if
129 # that resource is a video. This property is only present if the
130 # &lt;code&gt;resourceId.kind&lt;/code&gt; value is &lt;code&gt;youtube#video&lt;/code&gt;.
131 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the referred resource, if
132 # that resource is a channel. This property is only present if the
133 # &lt;code&gt;resourceId.kind&lt;/code&gt; value is &lt;code&gt;youtube#channel&lt;/code&gt;.
134 &quot;playlistId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the referred resource, if
135 # that resource is a playlist. This property is only present if the
136 # &lt;code&gt;resourceId.kind&lt;/code&gt; value is &lt;code&gt;youtube#playlist&lt;/code&gt;.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]137 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]138 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the subscriber&#x27;s channel.
139 &quot;description&quot;: &quot;A String&quot;, # The subscription&#x27;s details.
140 &quot;thumbnails&quot;: { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object
141 # in the map, the key is the name of the thumbnail image, and the value
142 # is an object that contains other information about the thumbnail.
143 &quot;medium&quot;: { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
144 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
145 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
146 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]148 &quot;standard&quot;: { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
149 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
150 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
151 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]152 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]153 &quot;default&quot;: { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
154 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
155 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
156 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
157 },
158 &quot;maxres&quot;: { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
159 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
160 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
161 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
162 },
163 &quot;high&quot;: { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
164 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
165 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
166 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
167 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]168 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]169 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the subscription was created. The value is
170 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
171 # format.
172 },
173 &quot;kind&quot;: &quot;youtube#subscription&quot;, # Identifies what kind of resource this is. Value: the fixed string
174 # &lt;code&gt;&quot;youtube#subscription&quot;&lt;/code&gt;.
175 &quot;contentDetails&quot;: { # Details about the content to witch a subscription refers. # The &lt;code&gt;contentDetails&lt;/code&gt; object contains basic statistics about the
176 # subscription.
177 &quot;newItemCount&quot;: 42, # The number of new items in the subscription since its content was last
178 # read.
179 &quot;activityType&quot;: &quot;A String&quot;, # The type of activity this subscription is for
180 # (only uploads, everything).
181 &quot;totalItemCount&quot;: 42, # The approximate number of items that the subscription points to.
182 },
183 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
184 &quot;subscriberSnippet&quot;: { # Basic details about a subscription&#x27;s subscriber including title, # The &lt;code&gt;subscriberSnippet&lt;/code&gt; object contains basic details about the
185 # subscriber.
186 # description, channel ID and thumbnails.
187 &quot;thumbnails&quot;: { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber.
188 &quot;medium&quot;: { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
189 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
190 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
191 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]192 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]193 &quot;standard&quot;: { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
194 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
195 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
196 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
197 },
198 &quot;default&quot;: { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
199 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
200 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
201 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
202 },
203 &quot;maxres&quot;: { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
204 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
205 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
206 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
207 },
208 &quot;high&quot;: { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
209 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
210 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
211 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
212 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]213 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]214 &quot;title&quot;: &quot;A String&quot;, # The title of the subscriber.
215 &quot;description&quot;: &quot;A String&quot;, # The description of the subscriber.
216 &quot;channelId&quot;: &quot;A String&quot;, # The channel ID of the subscriber.
217 },
218 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the subscription.
219}
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]220
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]221 x__xgafv: string, V1 error format.
222 Allowed values
223 1 - v1 error format
224 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]225
226Returns:
227 An object of the form:
228
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]229 { # A &lt;code&gt;&lt;strong&gt;subscription&lt;/strong&gt;&lt;/code&gt; resource contains information
230 # about a YouTube user subscription. A subscription notifies a user when new
231 # videos are added to a channel or when another user takes one of several
232 # actions on YouTube, such as uploading a video, rating a video, or commenting
233 # on a video.
234 &quot;snippet&quot;: { # Basic details about a subscription, including title, description and # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the
235 # subscription, including its title and the channel that the user subscribed
236 # to.
237 # thumbnails of the subscribed item.
238 &quot;title&quot;: &quot;A String&quot;, # The subscription&#x27;s title.
239 &quot;channelTitle&quot;: &quot;A String&quot;, # Channel title for the channel that the subscription belongs to.
240 &quot;resourceId&quot;: { # A resource id is a generic reference that points to another YouTube resource. # The &lt;code&gt;id&lt;/code&gt; object contains information about the channel that
241 # the user subscribed to.
242 &quot;kind&quot;: &quot;A String&quot;, # The type of the API resource.
243 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the referred resource, if
244 # that resource is a video. This property is only present if the
245 # &lt;code&gt;resourceId.kind&lt;/code&gt; value is &lt;code&gt;youtube#video&lt;/code&gt;.
246 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the referred resource, if
247 # that resource is a channel. This property is only present if the
248 # &lt;code&gt;resourceId.kind&lt;/code&gt; value is &lt;code&gt;youtube#channel&lt;/code&gt;.
249 &quot;playlistId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the referred resource, if
250 # that resource is a playlist. This property is only present if the
251 # &lt;code&gt;resourceId.kind&lt;/code&gt; value is &lt;code&gt;youtube#playlist&lt;/code&gt;.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]252 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]253 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the subscriber&#x27;s channel.
254 &quot;description&quot;: &quot;A String&quot;, # The subscription&#x27;s details.
255 &quot;thumbnails&quot;: { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object
256 # in the map, the key is the name of the thumbnail image, and the value
257 # is an object that contains other information about the thumbnail.
258 &quot;medium&quot;: { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
259 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
260 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
261 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]262 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]263 &quot;standard&quot;: { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
264 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
265 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
266 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]267 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]268 &quot;default&quot;: { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
269 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
270 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
271 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
272 },
273 &quot;maxres&quot;: { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
274 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
275 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
276 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
277 },
278 &quot;high&quot;: { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
279 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
280 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
281 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
282 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]283 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]284 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the subscription was created. The value is
285 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
286 # format.
287 },
288 &quot;kind&quot;: &quot;youtube#subscription&quot;, # Identifies what kind of resource this is. Value: the fixed string
289 # &lt;code&gt;&quot;youtube#subscription&quot;&lt;/code&gt;.
290 &quot;contentDetails&quot;: { # Details about the content to witch a subscription refers. # The &lt;code&gt;contentDetails&lt;/code&gt; object contains basic statistics about the
291 # subscription.
292 &quot;newItemCount&quot;: 42, # The number of new items in the subscription since its content was last
293 # read.
294 &quot;activityType&quot;: &quot;A String&quot;, # The type of activity this subscription is for
295 # (only uploads, everything).
296 &quot;totalItemCount&quot;: 42, # The approximate number of items that the subscription points to.
297 },
298 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
299 &quot;subscriberSnippet&quot;: { # Basic details about a subscription&#x27;s subscriber including title, # The &lt;code&gt;subscriberSnippet&lt;/code&gt; object contains basic details about the
300 # subscriber.
301 # description, channel ID and thumbnails.
302 &quot;thumbnails&quot;: { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber.
303 &quot;medium&quot;: { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
304 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
305 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
306 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]307 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]308 &quot;standard&quot;: { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
309 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
310 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
311 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
312 },
313 &quot;default&quot;: { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
314 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
315 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
316 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
317 },
318 &quot;maxres&quot;: { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
319 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
320 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
321 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
322 },
323 &quot;high&quot;: { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
324 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
325 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
326 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
327 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]328 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]329 &quot;title&quot;: &quot;A String&quot;, # The title of the subscriber.
330 &quot;description&quot;: &quot;A String&quot;, # The description of the subscriber.
331 &quot;channelId&quot;: &quot;A String&quot;, # The channel ID of the subscriber.
332 },
333 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the subscription.
334 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]335</div>
336
337<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]338 <code class="details" id="list">list(part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, mine=None, channelId=None, forChannelId=None, order=None, id=None, mySubscribers=None, myRecentSubscribers=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
339 <pre>Retrieves a list of resources, possibly filtered.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]340
341Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]342 part: string, The &lt;code&gt;&lt;strong&gt;part&lt;/strong&gt;&lt;/code&gt; parameter specifies a
343comma-separated list of one or more &lt;code&gt;subscription&lt;/code&gt; resource
344properties that the API response will include.&lt;br&gt;&lt;br&gt;If the parameter
345identifies a property that contains child properties, the child properties
346will be included in the response. For example, in a
347&lt;code&gt;subscription&lt;/code&gt; resource, the &lt;code&gt;snippet&lt;/code&gt; property
348contains other properties, such as a display title for the subscription. If
349you set &lt;code&gt;&lt;strong&gt;part=snippet&lt;/strong&gt;&lt;/code&gt;, the API response will
350also contain all of those nested properties. (required) (repeated)
351 onBehalfOfContentOwner: string, &lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
352content partners.&lt;br&gt;&lt;br&gt;The
353&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwner&lt;/strong&gt;&lt;/code&gt; parameter indicates
354that the
355request&#x27;s authorization credentials identify a YouTube CMS user who is
356acting on behalf of the content owner specified in the parameter value.
357This parameter is intended for YouTube content partners that own and manage
358many different YouTube channels. It allows content owners to authenticate
359once and get access to all their video and channel data, without having to
360provide authentication credentials for each individual channel. The CMS
361account that the user authenticates with must be linked to the specified
362YouTube content owner.
363 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly &lt;a
364href=&quot;/youtube/v3/guides/authentication&quot;&gt;authorized request&lt;/a&gt;.
365&lt;strong&gt;Note:&lt;/strong&gt; This parameter is intended exclusively for YouTube
366content partners.&lt;br&gt;&lt;br&gt;The
367&lt;code&gt;&lt;strong&gt;onBehalfOfContentOwnerChannel&lt;/strong&gt;&lt;/code&gt; parameter
368specifies the YouTube channel ID of the channel to which a video is being
369added. This parameter is required when a request specifies a value for the
370&lt;code&gt;onBehalfOfContentOwner&lt;/code&gt; parameter, and it can only be used in
371conjunction with that parameter. In addition, the request must be
372authorized using a CMS account that is linked to the content owner that the
373&lt;code&gt;onBehalfOfContentOwner&lt;/code&gt; parameter specifies. Finally, the
374channel that the &lt;code&gt;onBehalfOfContentOwnerChannel&lt;/code&gt; parameter value
375specifies must be linked to the content owner that the
376&lt;code&gt;onBehalfOfContentOwner&lt;/code&gt; parameter specifies.&lt;br&gt;&lt;br&gt;This
377parameter is intended for YouTube content partners that own and manage many
378different YouTube channels. It allows content owners to authenticate once
379and perform actions on behalf of the channel specified in the parameter
380value, without having to provide authentication credentials for each
381separate channel.
382 mine: boolean, Flag for returning the subscriptions of the authenticated user.
383 channelId: string, Return the subscriptions of the given channel owner.
384 forChannelId: string, Return the subscriptions to the subset of these channels that the
385authenticated user is subscribed to.
386 order: string, The order of the returned subscriptions
387 id: string, Return the subscriptions with the given IDs for Stubby or Apiary. (repeated)
388 mySubscribers: boolean, Return the subscribers of the given channel owner.
389 myRecentSubscribers: boolean, A parameter
390 maxResults: integer, The &lt;code&gt;&lt;strong&gt;maxResults&lt;/strong&gt;&lt;/code&gt; parameter specifies the
391maximum number of items that should be returned in the result set.
392 pageToken: string, The &lt;code&gt;&lt;strong&gt;pageToken&lt;/strong&gt;&lt;/code&gt; parameter identifies a specific
393page in the result set that should be returned. In an API response, the
394&lt;code&gt;nextPageToken&lt;/code&gt; and &lt;code&gt;prevPageToken&lt;/code&gt; properties
395identify other pages that could be retrieved.
396 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]397 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]398 1 - v1 error format
399 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]400
401Returns:
402 An object of the form:
403
404 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]405 &quot;tokenPagination&quot;: { # Stub token pagination template to suppress results.
406 },
407 &quot;prevPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the &lt;code&gt;pageToken&lt;/code&gt;
408 # parameter to retrieve the previous page in the result set.
409 &quot;items&quot;: [ # A list of subscriptions that match the request criteria.
410 { # A &lt;code&gt;&lt;strong&gt;subscription&lt;/strong&gt;&lt;/code&gt; resource contains information
411 # about a YouTube user subscription. A subscription notifies a user when new
412 # videos are added to a channel or when another user takes one of several
413 # actions on YouTube, such as uploading a video, rating a video, or commenting
414 # on a video.
415 &quot;snippet&quot;: { # Basic details about a subscription, including title, description and # The &lt;code&gt;snippet&lt;/code&gt; object contains basic details about the
416 # subscription, including its title and the channel that the user subscribed
417 # to.
418 # thumbnails of the subscribed item.
419 &quot;title&quot;: &quot;A String&quot;, # The subscription&#x27;s title.
420 &quot;channelTitle&quot;: &quot;A String&quot;, # Channel title for the channel that the subscription belongs to.
421 &quot;resourceId&quot;: { # A resource id is a generic reference that points to another YouTube resource. # The &lt;code&gt;id&lt;/code&gt; object contains information about the channel that
422 # the user subscribed to.
423 &quot;kind&quot;: &quot;A String&quot;, # The type of the API resource.
424 &quot;videoId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the referred resource, if
425 # that resource is a video. This property is only present if the
426 # &lt;code&gt;resourceId.kind&lt;/code&gt; value is &lt;code&gt;youtube#video&lt;/code&gt;.
427 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the referred resource, if
428 # that resource is a channel. This property is only present if the
429 # &lt;code&gt;resourceId.kind&lt;/code&gt; value is &lt;code&gt;youtube#channel&lt;/code&gt;.
430 &quot;playlistId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the referred resource, if
431 # that resource is a playlist. This property is only present if the
432 # &lt;code&gt;resourceId.kind&lt;/code&gt; value is &lt;code&gt;youtube#playlist&lt;/code&gt;.
433 },
434 &quot;channelId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the subscriber&#x27;s channel.
435 &quot;description&quot;: &quot;A String&quot;, # The subscription&#x27;s details.
436 &quot;thumbnails&quot;: { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object
437 # in the map, the key is the name of the thumbnail image, and the value
438 # is an object that contains other information about the thumbnail.
439 &quot;medium&quot;: { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
440 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
441 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
442 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
443 },
444 &quot;standard&quot;: { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
445 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
446 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
447 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
448 },
449 &quot;default&quot;: { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
450 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
451 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
452 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
453 },
454 &quot;maxres&quot;: { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
455 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
456 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
457 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
458 },
459 &quot;high&quot;: { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
460 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
461 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
462 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
463 },
464 },
465 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the subscription was created. The value is
466 # specified in &lt;a href=&quot;//www.w3.org/TR/NOTE-datetime&quot;&gt;ISO 8601&lt;/a&gt;
467 # format.
468 },
469 &quot;kind&quot;: &quot;youtube#subscription&quot;, # Identifies what kind of resource this is. Value: the fixed string
470 # &lt;code&gt;&quot;youtube#subscription&quot;&lt;/code&gt;.
471 &quot;contentDetails&quot;: { # Details about the content to witch a subscription refers. # The &lt;code&gt;contentDetails&lt;/code&gt; object contains basic statistics about the
472 # subscription.
473 &quot;newItemCount&quot;: 42, # The number of new items in the subscription since its content was last
474 # read.
475 &quot;activityType&quot;: &quot;A String&quot;, # The type of activity this subscription is for
476 # (only uploads, everything).
477 &quot;totalItemCount&quot;: 42, # The approximate number of items that the subscription points to.
478 },
479 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
480 &quot;subscriberSnippet&quot;: { # Basic details about a subscription&#x27;s subscriber including title, # The &lt;code&gt;subscriberSnippet&lt;/code&gt; object contains basic details about the
481 # subscriber.
482 # description, channel ID and thumbnails.
483 &quot;thumbnails&quot;: { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber.
484 &quot;medium&quot;: { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
485 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
486 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
487 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
488 },
489 &quot;standard&quot;: { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
490 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
491 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
492 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
493 },
494 &quot;default&quot;: { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
495 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
496 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
497 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
498 },
499 &quot;maxres&quot;: { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
500 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
501 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
502 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
503 },
504 &quot;high&quot;: { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
505 &quot;width&quot;: 42, # (Optional) Width of the thumbnail image.
506 &quot;url&quot;: &quot;A String&quot;, # The thumbnail image&#x27;s URL.
507 &quot;height&quot;: 42, # (Optional) Height of the thumbnail image.
508 },
509 },
510 &quot;title&quot;: &quot;A String&quot;, # The title of the subscriber.
511 &quot;description&quot;: &quot;A String&quot;, # The description of the subscriber.
512 &quot;channelId&quot;: &quot;A String&quot;, # The channel ID of the subscriber.
513 },
514 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the subscription.
515 },
516 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]517 &quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
518 &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^]519 &quot;kind&quot;: &quot;youtube#subscriptionListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string
520 # &lt;code&gt;&quot;youtube#subscriptionListResponse&quot;&lt;/code&gt;.
521 &quot;visitorId&quot;: &quot;A String&quot;, # The &lt;code&gt;visitorId&lt;/code&gt; identifies the visitor.
522 &quot;pageInfo&quot;: { # Paging details for lists of resources, including total number of items
523 # available and number of resources returned in a single page.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]524 &quot;resultsPerPage&quot;: 42, # The number of results included in the API response.
525 &quot;totalResults&quot;: 42, # The total number of results in the result set.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]526 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]527 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the &lt;code&gt;pageToken&lt;/code&gt;
528 # parameter to retrieve the next page in the result set.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]529 }</pre>
530</div>
531
532<div class="method">
533 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
534 <pre>Retrieves the next page of results.
535
536Args:
537 previous_request: The request for the previous page. (required)
538 previous_response: The response from the request for the previous page. (required)
539
540Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]541 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]542 page. Returns None if there are no more items in the collection.
543 </pre>
544</div>
545
546</body></html>