Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / dyn / youtube_v3.subscriptions.html
blob: 68f9232754f203e6d16233575d9a97c5c1cc709d [file] [log] [blame]
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[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
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]75<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.subscriptions.html">subscriptions</a></h1>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]78 <code><a href="#delete">delete(id)</a></code></p>
79<p class="firstline">Deletes a subscription.</p>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]80<p class="toc_element">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]81 <code><a href="#insert">insert(part=None, body)</a></code></p>
82<p class="firstline">Adds a subscription for the authenticated user's channel.</p>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]83<p class="toc_element">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]84 <code><a href="#list">list(part=None, pageToken=None, id=None, channelId=None, mine=None, maxResults=None, forChannelId=None, mySubscribers=None, order=None)</a></code></p>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]85<p class="firstline">Returns subscription resources that match the API request criteria.</p>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[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">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]91 <code class="details" id="delete">delete(id)</code>
92 <pre>Deletes a subscription.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]93
94Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]95 id: string, The id parameter specifies the YouTube subscription ID for the resource that is being deleted. In a subscription resource, the id property specifies the YouTube subscription ID. (required)
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]96</pre>
97</div>
98
99<div class="method">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]100 <code class="details" id="insert">insert(part=None, body)</code>
101 <pre>Adds a subscription for the authenticated user's channel.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]102
103Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]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)
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]107 body: object, The request body. (required)
108 The object takes the form of:
109
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]110{ # A subscription resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]111 "kind": "youtube#subscription", # The kind, fixed to "youtube#subscription".
112 "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription.
113 "newItemCount": 42, # The number of new items in the subscription since its content was last read.
114 "activityType": "A String", # The type of activity this subscription is for (only uploads, everything).
115 "totalItemCount": 42, # The approximate number of items that the subscription points to.
116 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]117 "snippet": { # Basic details about a subscription, including title, description and thumbnails of the subscribed item. # The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]118 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
119 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
120 "url": "A String", # The thumbnail image's URL.
121 "width": 42, # (Optional) Width of the thumbnail image.
122 "height": 42, # (Optional) Height of the thumbnail image.
123 },
124 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
125 "url": "A String", # The thumbnail image's URL.
126 "width": 42, # (Optional) Width of the thumbnail image.
127 "height": 42, # (Optional) Height of the thumbnail image.
128 },
129 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
130 "url": "A String", # The thumbnail image's URL.
131 "width": 42, # (Optional) Width of the thumbnail image.
132 "height": 42, # (Optional) Height of the thumbnail image.
133 },
134 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
135 "url": "A String", # The thumbnail image's URL.
136 "width": 42, # (Optional) Width of the thumbnail image.
137 "height": 42, # (Optional) Height of the thumbnail image.
138 },
139 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
140 "url": "A String", # The thumbnail image's URL.
141 "width": 42, # (Optional) Width of the thumbnail image.
142 "height": 42, # (Optional) Height of the thumbnail image.
143 },
144 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]145 "title": "A String", # The subscription's title.
146 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information about the channel that the user subscribed to.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]147 "kind": "A String", # The type of the API resource.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]148 "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
149 "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
150 "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]151 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]152 "channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel.
153 "publishedAt": "A String", # The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]154 "channelTitle": "A String", # Channel title for the channel that the subscription belongs to.
155 "description": "A String", # The subscription's details.
156 },
157 "etag": "A String", # Etag of this resource.
158 "subscriberSnippet": { # Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. # The subscriberSnippet object contains basic details about the sbuscriber.
159 "title": "A String", # The title of the subscriber.
160 "channelId": "A String", # The channel ID of the subscriber.
161 "description": "A String", # The description of the subscriber.
162 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber.
163 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
164 "url": "A String", # The thumbnail image's URL.
165 "width": 42, # (Optional) Width of the thumbnail image.
166 "height": 42, # (Optional) Height of the thumbnail image.
167 },
168 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
169 "url": "A String", # The thumbnail image's URL.
170 "width": 42, # (Optional) Width of the thumbnail image.
171 "height": 42, # (Optional) Height of the thumbnail image.
172 },
173 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
174 "url": "A String", # The thumbnail image's URL.
175 "width": 42, # (Optional) Width of the thumbnail image.
176 "height": 42, # (Optional) Height of the thumbnail image.
177 },
178 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
179 "url": "A String", # The thumbnail image's URL.
180 "width": 42, # (Optional) Width of the thumbnail image.
181 "height": 42, # (Optional) Height of the thumbnail image.
182 },
183 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]184 "url": "A String", # The thumbnail image's URL.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]185 "width": 42, # (Optional) Width of the thumbnail image.
186 "height": 42, # (Optional) Height of the thumbnail image.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]187 },
188 },
189 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]190 "id": "A String", # The ID that YouTube uses to uniquely identify the subscription.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]191 }
192
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]193
194Returns:
195 An object of the form:
196
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]197 { # A subscription resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]198 "kind": "youtube#subscription", # The kind, fixed to "youtube#subscription".
199 "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription.
200 "newItemCount": 42, # The number of new items in the subscription since its content was last read.
201 "activityType": "A String", # The type of activity this subscription is for (only uploads, everything).
202 "totalItemCount": 42, # The approximate number of items that the subscription points to.
203 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]204 "snippet": { # Basic details about a subscription, including title, description and thumbnails of the subscribed item. # The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]205 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
206 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
207 "url": "A String", # The thumbnail image's URL.
208 "width": 42, # (Optional) Width of the thumbnail image.
209 "height": 42, # (Optional) Height of the thumbnail image.
210 },
211 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
212 "url": "A String", # The thumbnail image's URL.
213 "width": 42, # (Optional) Width of the thumbnail image.
214 "height": 42, # (Optional) Height of the thumbnail image.
215 },
216 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
217 "url": "A String", # The thumbnail image's URL.
218 "width": 42, # (Optional) Width of the thumbnail image.
219 "height": 42, # (Optional) Height of the thumbnail image.
220 },
221 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
222 "url": "A String", # The thumbnail image's URL.
223 "width": 42, # (Optional) Width of the thumbnail image.
224 "height": 42, # (Optional) Height of the thumbnail image.
225 },
226 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
227 "url": "A String", # The thumbnail image's URL.
228 "width": 42, # (Optional) Width of the thumbnail image.
229 "height": 42, # (Optional) Height of the thumbnail image.
230 },
231 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]232 "title": "A String", # The subscription's title.
233 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information about the channel that the user subscribed to.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]234 "kind": "A String", # The type of the API resource.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]235 "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
236 "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
237 "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]238 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]239 "channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel.
240 "publishedAt": "A String", # The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]241 "channelTitle": "A String", # Channel title for the channel that the subscription belongs to.
242 "description": "A String", # The subscription's details.
243 },
244 "etag": "A String", # Etag of this resource.
245 "subscriberSnippet": { # Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. # The subscriberSnippet object contains basic details about the sbuscriber.
246 "title": "A String", # The title of the subscriber.
247 "channelId": "A String", # The channel ID of the subscriber.
248 "description": "A String", # The description of the subscriber.
249 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber.
250 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
251 "url": "A String", # The thumbnail image's URL.
252 "width": 42, # (Optional) Width of the thumbnail image.
253 "height": 42, # (Optional) Height of the thumbnail image.
254 },
255 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
256 "url": "A String", # The thumbnail image's URL.
257 "width": 42, # (Optional) Width of the thumbnail image.
258 "height": 42, # (Optional) Height of the thumbnail image.
259 },
260 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
261 "url": "A String", # The thumbnail image's URL.
262 "width": 42, # (Optional) Width of the thumbnail image.
263 "height": 42, # (Optional) Height of the thumbnail image.
264 },
265 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
266 "url": "A String", # The thumbnail image's URL.
267 "width": 42, # (Optional) Width of the thumbnail image.
268 "height": 42, # (Optional) Height of the thumbnail image.
269 },
270 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]271 "url": "A String", # The thumbnail image's URL.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]272 "width": 42, # (Optional) Width of the thumbnail image.
273 "height": 42, # (Optional) Height of the thumbnail image.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]274 },
275 },
276 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]277 "id": "A String", # The ID that YouTube uses to uniquely identify the subscription.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]278 }</pre>
279</div>
280
281<div class="method">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]282 <code class="details" id="list">list(part=None, pageToken=None, id=None, channelId=None, mine=None, maxResults=None, forChannelId=None, mySubscribers=None, order=None)</code>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]283 <pre>Returns subscription resources that match the API request criteria.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]284
285Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]286 part: string, The part parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails.
287
288If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet, the API response will also contain all of those nested properties. (required)
289 pageToken: string, USE_DESCRIPTION --- channels:list:pageToken
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]290 id: string, The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]291 channelId: string, The channelId parameter specifies a YouTube channel ID. The API will only return that channel's subscriptions.
292 mine: boolean, Set this parameter's value to true to retrieve a feed of the authenticated user's subscriptions.
293 maxResults: integer, USE_DESCRIPTION --- channels:list:maxResults
294 forChannelId: string, The forChannelId parameter specifies a comma-separated list of channel IDs. The API response will then only contain subscriptions matching those channels.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]295 mySubscribers: boolean, Set this parameter's value to true to retrieve a feed of the subscribers of the authenticated user.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]296 order: string, The order parameter specifies the method that will be used to sort resources in the API response.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]297 Allowed values
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]298 alphabetical - Sort alphabetically.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]299 relevance - Sort by relevance.
300 unread - Sort by order of activity.
301
302Returns:
303 An object of the form:
304
305 { # A paginated list of subscriptions returned as the response to a youtube.subscriptions.list call.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]306 "eventId": "A String", # Serialized EventId of the request which produced this response.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]307 "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
308 "kind": "youtube#subscriptionListResponse", # The type of the API response. For this operation, the value will be youtube#subscriptionListResponse.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]309 "visitorId": "A String", # The visitorId identifies the visitor.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]310 "items": [ # A list of subscriptions that match the request criteria.
311 { # A subscription resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]312 "kind": "youtube#subscription", # The kind, fixed to "youtube#subscription".
313 "contentDetails": { # Details about the content to witch a subscription refers. # The contentDetails object contains basic statistics about the subscription.
314 "newItemCount": 42, # The number of new items in the subscription since its content was last read.
315 "activityType": "A String", # The type of activity this subscription is for (only uploads, everything).
316 "totalItemCount": 42, # The approximate number of items that the subscription points to.
317 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]318 "snippet": { # Basic details about a subscription, including title, description and thumbnails of the subscribed item. # The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]319 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
320 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
321 "url": "A String", # The thumbnail image's URL.
322 "width": 42, # (Optional) Width of the thumbnail image.
323 "height": 42, # (Optional) Height of the thumbnail image.
324 },
325 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
326 "url": "A String", # The thumbnail image's URL.
327 "width": 42, # (Optional) Width of the thumbnail image.
328 "height": 42, # (Optional) Height of the thumbnail image.
329 },
330 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
331 "url": "A String", # The thumbnail image's URL.
332 "width": 42, # (Optional) Width of the thumbnail image.
333 "height": 42, # (Optional) Height of the thumbnail image.
334 },
335 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
336 "url": "A String", # The thumbnail image's URL.
337 "width": 42, # (Optional) Width of the thumbnail image.
338 "height": 42, # (Optional) Height of the thumbnail image.
339 },
340 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
341 "url": "A String", # The thumbnail image's URL.
342 "width": 42, # (Optional) Width of the thumbnail image.
343 "height": 42, # (Optional) Height of the thumbnail image.
344 },
345 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]346 "title": "A String", # The subscription's title.
347 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The id object contains information about the channel that the user subscribed to.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]348 "kind": "A String", # The type of the API resource.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]349 "channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel.
350 "playlistId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist.
351 "videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]352 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]353 "channelId": "A String", # The ID that YouTube uses to uniquely identify the subscriber's channel.
354 "publishedAt": "A String", # The date and time that the subscription was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]355 "channelTitle": "A String", # Channel title for the channel that the subscription belongs to.
356 "description": "A String", # The subscription's details.
357 },
358 "etag": "A String", # Etag of this resource.
359 "subscriberSnippet": { # Basic details about a subscription's subscriber including title, description, channel ID and thumbnails. # The subscriberSnippet object contains basic details about the sbuscriber.
360 "title": "A String", # The title of the subscriber.
361 "channelId": "A String", # The channel ID of the subscriber.
362 "description": "A String", # The description of the subscriber.
363 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # Thumbnails for this subscriber.
364 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
365 "url": "A String", # The thumbnail image's URL.
366 "width": 42, # (Optional) Width of the thumbnail image.
367 "height": 42, # (Optional) Height of the thumbnail image.
368 },
369 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
370 "url": "A String", # The thumbnail image's URL.
371 "width": 42, # (Optional) Width of the thumbnail image.
372 "height": 42, # (Optional) Height of the thumbnail image.
373 },
374 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
375 "url": "A String", # The thumbnail image's URL.
376 "width": 42, # (Optional) Width of the thumbnail image.
377 "height": 42, # (Optional) Height of the thumbnail image.
378 },
379 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
380 "url": "A String", # The thumbnail image's URL.
381 "width": 42, # (Optional) Width of the thumbnail image.
382 "height": 42, # (Optional) Height of the thumbnail image.
383 },
384 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]385 "url": "A String", # The thumbnail image's URL.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]386 "width": 42, # (Optional) Width of the thumbnail image.
387 "height": 42, # (Optional) Height of the thumbnail image.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]388 },
389 },
390 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]391 "id": "A String", # The ID that YouTube uses to uniquely identify the subscription.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]392 },
393 ],
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]394 "etag": "A String", # The ETag of the response.
395 "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
396 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the result set.
397 "totalResults": 42, # The total number of results in the result set.
398 "resultsPerPage": 42, # The number of results included in the API response.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]399 },
400 }</pre>
401</div>
402
403<div class="method">
404 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
405 <pre>Retrieves the next page of results.
406
407Args:
408 previous_request: The request for the previous page. (required)
409 previous_response: The response from the request for the previous page. (required)
410
411Returns:
412 A request object that you can call 'execute()' on to request the next
413 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]414 </pre>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]415</div>
416
417</body></html>