Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e912d185eef03392f095881d407c0c78f7633d5e / . / docs / dyn / youtube_v3.activities.html
blob: 4f7c0aa1c856c432c5e33a0e5d3c22dc1b42106f [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.activities.html">activities</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="#insert">insert(part=None, body)</a></code></p>
79<p class="firstline">Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.)</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="#list">list(part=None, pageToken=None, publishedBefore=None, channelId=None, mine=None, maxResults=None, home=None, publishedAfter=None)</a></code></p>
82<p class="firstline">Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user.</p>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]88 <code class="details" id="insert">insert(part=None, body)</code>
89 <pre>Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.)
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]90
91Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]92 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.
93
94The 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]95 body: object, The request body. (required)
96 The object takes the form of:
97
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]98{ # An activity resource contains information about an action that a particular channel, or user, has taken on YouTube. The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.
99 "snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. # The snippet object contains basic details about the activity, including the activity's type and group ID.
100 "thumbnails": { # A map of thumbnail images associated with the resource that is primarily associated with the activity. 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.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]101 "a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]102 "url": "A String", # The thumbnail image's URL.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]103 "width": 42, # (Optional) Width of the thumbnail image.
104 "height": 42, # (Optional) Height of the thumbnail image.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]105 },
106 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]107 "title": "A String", # The title of the resource primarily associated with the activity.
108 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated with the activity.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]109 "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
110 "channelTitle": "A String", # Channel title for the channel responsible for this activity
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]111 "type": "A String", # The type of activity that the resource describes.
112 "groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value.
113 "description": "A String", # The description of the resource primarily associated with the activity.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]114 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]115 "contentDetails": { # Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc. # The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video.
116 "comment": { # The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment.
117 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with the comment.
118 "kind": "A String", # The kind, or type, of the referred resource.
119 "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.
120 "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.
121 "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]122 },
123 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]124 "playlistItem": { # The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem.
125 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information about the resource that was added to the playlist.
126 "kind": "A String", # The kind, or type, of the referred resource.
127 "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.
128 "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.
129 "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]130 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]131 "playlistId": "A String", # The value that YouTube uses to uniquely identify the playlist.
132 "playlistItemId": "A String", # ID of the item within the playlist.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]133 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]134 "like": { # The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like.
135 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the rated resource.
136 "kind": "A String", # The kind, or type, of the referred resource.
137 "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.
138 "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.
139 "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]140 },
141 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]142 "social": { # The social object contains details about a social network post. This property is only present if the snippet.type is social.
143 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object encapsulates information that identifies the resource associated with a social network post.
144 "kind": "A String", # The kind, or type, of the referred resource.
145 "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.
146 "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.
147 "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]148 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]149 "imageUrl": "A String", # An image of the post's author.
150 "type": "A String", # The name of the social network.
151 "referenceUrl": "A String", # The URL of the social network post.
152 "author": "A String", # The author of the social network post.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]153 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]154 "favorite": { # The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite.
155 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was marked as a favorite.
156 "kind": "A String", # The kind, or type, of the referred resource.
157 "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.
158 "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.
159 "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]160 },
161 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]162 "upload": { # The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload.
163 "videoId": "A String", # The ID that YouTube uses to uniquely identify the uploaded video.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]164 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]165 "recommendation": { # The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation.
166 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the recommended resource.
167 "kind": "A String", # The kind, or type, of the referred resource.
168 "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.
169 "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.
170 "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]171 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]172 "reason": "A String", # The reason that the resource is recommended to the user.
173 "seedResourceId": { # A resource id is a generic reference that points to another YouTube resource. # The seedResourceId object contains information about the resource that caused the recommendation.
174 "kind": "A String", # The kind, or type, of the referred resource.
175 "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.
176 "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.
177 "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]178 },
179 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]180 "subscription": { # The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription.
181 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that the user subscribed to.
182 "kind": "A String", # The kind, or type, of the referred resource.
183 "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.
184 "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.
185 "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]186 },
187 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]188 "bulletin": { # The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin.
189 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with a bulletin post.
190 "kind": "A String", # The kind, or type, of the referred resource.
191 "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.
192 "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.
193 "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.
194 },
195 },
196 "channelItem": { # The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem.
197 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was added to the channel.
198 "kind": "A String", # The kind, or type, of the referred resource.
199 "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.
200 "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.
201 "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]202 },
203 },
204 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]205 "kind": "youtube#activity", # The type of the API resource. For activity resources, the value will be youtube#activity.
206 "etag": "A String", # The ETag of the activity resource.
207 "id": "A String", # The ID that YouTube uses to uniquely identify the activity.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]208 }
209
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]210
211Returns:
212 An object of the form:
213
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]214 { # An activity resource contains information about an action that a particular channel, or user, has taken on YouTube. The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.
215 "snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. # The snippet object contains basic details about the activity, including the activity's type and group ID.
216 "thumbnails": { # A map of thumbnail images associated with the resource that is primarily associated with the activity. 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.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]217 "a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]218 "url": "A String", # The thumbnail image's URL.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]219 "width": 42, # (Optional) Width of the thumbnail image.
220 "height": 42, # (Optional) Height of the thumbnail image.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]221 },
222 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]223 "title": "A String", # The title of the resource primarily associated with the activity.
224 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated with the activity.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]225 "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
226 "channelTitle": "A String", # Channel title for the channel responsible for this activity
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]227 "type": "A String", # The type of activity that the resource describes.
228 "groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value.
229 "description": "A String", # The description of the resource primarily associated with the activity.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]230 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]231 "contentDetails": { # Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc. # The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video.
232 "comment": { # The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment.
233 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with the comment.
234 "kind": "A String", # The kind, or type, of the referred resource.
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 },
239 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]240 "playlistItem": { # The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem.
241 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information about the resource that was added to the playlist.
242 "kind": "A String", # The kind, or type, of the referred resource.
243 "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.
244 "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.
245 "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]246 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]247 "playlistId": "A String", # The value that YouTube uses to uniquely identify the playlist.
248 "playlistItemId": "A String", # ID of the item within the playlist.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]249 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]250 "like": { # The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like.
251 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the rated resource.
252 "kind": "A String", # The kind, or type, of the referred resource.
253 "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.
254 "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.
255 "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]256 },
257 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]258 "social": { # The social object contains details about a social network post. This property is only present if the snippet.type is social.
259 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object encapsulates information that identifies the resource associated with a social network post.
260 "kind": "A String", # The kind, or type, of the referred resource.
261 "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.
262 "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.
263 "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]264 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]265 "imageUrl": "A String", # An image of the post's author.
266 "type": "A String", # The name of the social network.
267 "referenceUrl": "A String", # The URL of the social network post.
268 "author": "A String", # The author of the social network post.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]269 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]270 "favorite": { # The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite.
271 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was marked as a favorite.
272 "kind": "A String", # The kind, or type, of the referred resource.
273 "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.
274 "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.
275 "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]276 },
277 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]278 "upload": { # The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload.
279 "videoId": "A String", # The ID that YouTube uses to uniquely identify the uploaded video.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]280 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]281 "recommendation": { # The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation.
282 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the recommended resource.
283 "kind": "A String", # The kind, or type, of the referred resource.
284 "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.
285 "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.
286 "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]287 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]288 "reason": "A String", # The reason that the resource is recommended to the user.
289 "seedResourceId": { # A resource id is a generic reference that points to another YouTube resource. # The seedResourceId object contains information about the resource that caused the recommendation.
290 "kind": "A String", # The kind, or type, of the referred resource.
291 "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.
292 "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.
293 "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]294 },
295 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]296 "subscription": { # The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription.
297 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that the user subscribed to.
298 "kind": "A String", # The kind, or type, of the referred resource.
299 "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.
300 "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.
301 "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]302 },
303 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]304 "bulletin": { # The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin.
305 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with a bulletin post.
306 "kind": "A String", # The kind, or type, of the referred resource.
307 "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.
308 "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.
309 "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.
310 },
311 },
312 "channelItem": { # The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem.
313 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was added to the channel.
314 "kind": "A String", # The kind, or type, of the referred resource.
315 "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.
316 "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.
317 "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]318 },
319 },
320 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]321 "kind": "youtube#activity", # The type of the API resource. For activity resources, the value will be youtube#activity.
322 "etag": "A String", # The ETag of the activity resource.
323 "id": "A String", # The ID that YouTube uses to uniquely identify the activity.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]324 }</pre>
325</div>
326
327<div class="method">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]328 <code class="details" id="list">list(part=None, pageToken=None, publishedBefore=None, channelId=None, mine=None, maxResults=None, home=None, publishedAfter=None)</code>
329 <pre>Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]330
331Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]332 part: string, The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails.
333
334If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties. (required)
335 pageToken: string, USE_DESCRIPTION --- channels:list:pageToken
336 publishedBefore: string, The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
337 channelId: string, The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.
338 mine: boolean, Set this parameter's value to true to retrieve a feed of the authenticated user's activities.
339 maxResults: integer, USE_DESCRIPTION --- channels:list:maxResults
340 home: string, Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user.
341 publishedAfter: string, The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]342
343Returns:
344 An object of the form:
345
346 { # A paginated list of activities returned as a response to youtube.activities.list calls.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]347 "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.
348 "kind": "youtube#activityListResponse", # The type of the API response. For this operation, the value will be youtube#activityListResponse.
349 "items": [ # A list of activities, or events, that match the request criteria.
350 { # An activity resource contains information about an action that a particular channel, or user, has taken on YouTube. The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.
351 "snippet": { # Basic details about an activity, including title, description, thumbnails, activity type and group. # The snippet object contains basic details about the activity, including the activity's type and group ID.
352 "thumbnails": { # A map of thumbnail images associated with the resource that is primarily associated with the activity. 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.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]353 "a_key": { # A thumbnail is an image representing a YouTube resource. # Name of the thumbnail, to easily identify it. The set of names is dependent on the resource the thumbnail is for.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]354 "url": "A String", # The thumbnail image's URL.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]355 "width": 42, # (Optional) Width of the thumbnail image.
356 "height": 42, # (Optional) Height of the thumbnail image.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]357 },
358 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]359 "title": "A String", # The title of the resource primarily associated with the activity.
360 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel associated with the activity.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]361 "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
362 "channelTitle": "A String", # Channel title for the channel responsible for this activity
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]363 "type": "A String", # The type of activity that the resource describes.
364 "groupId": "A String", # The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value.
365 "description": "A String", # The description of the resource primarily associated with the activity.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]366 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]367 "contentDetails": { # Details about the content of an activity: the video that was shared, the channel that was subscribed to, etc. # The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video.
368 "comment": { # The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment.
369 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with the comment.
370 "kind": "A String", # The kind, or type, of the referred resource.
371 "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.
372 "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.
373 "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]374 },
375 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]376 "playlistItem": { # The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem.
377 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information about the resource that was added to the playlist.
378 "kind": "A String", # The kind, or type, of the referred resource.
379 "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.
380 "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.
381 "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]382 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]383 "playlistId": "A String", # The value that YouTube uses to uniquely identify the playlist.
384 "playlistItemId": "A String", # ID of the item within the playlist.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]385 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]386 "like": { # The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like.
387 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the rated resource.
388 "kind": "A String", # The kind, or type, of the referred resource.
389 "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.
390 "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.
391 "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]392 },
393 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]394 "social": { # The social object contains details about a social network post. This property is only present if the snippet.type is social.
395 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object encapsulates information that identifies the resource associated with a social network post.
396 "kind": "A String", # The kind, or type, of the referred resource.
397 "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.
398 "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.
399 "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]400 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]401 "imageUrl": "A String", # An image of the post's author.
402 "type": "A String", # The name of the social network.
403 "referenceUrl": "A String", # The URL of the social network post.
404 "author": "A String", # The author of the social network post.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]405 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]406 "favorite": { # The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite.
407 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was marked as a favorite.
408 "kind": "A String", # The kind, or type, of the referred resource.
409 "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.
410 "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.
411 "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]412 },
413 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]414 "upload": { # The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload.
415 "videoId": "A String", # The ID that YouTube uses to uniquely identify the uploaded video.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]416 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]417 "recommendation": { # The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation.
418 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the recommended resource.
419 "kind": "A String", # The kind, or type, of the referred resource.
420 "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.
421 "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.
422 "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]423 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]424 "reason": "A String", # The reason that the resource is recommended to the user.
425 "seedResourceId": { # A resource id is a generic reference that points to another YouTube resource. # The seedResourceId object contains information about the resource that caused the recommendation.
426 "kind": "A String", # The kind, or type, of the referred resource.
427 "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.
428 "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.
429 "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]430 },
431 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]432 "subscription": { # The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription.
433 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that the user subscribed to.
434 "kind": "A String", # The kind, or type, of the referred resource.
435 "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.
436 "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.
437 "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]438 },
439 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]440 "bulletin": { # The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin.
441 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource associated with a bulletin post.
442 "kind": "A String", # The kind, or type, of the referred resource.
443 "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.
444 "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.
445 "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.
446 },
447 },
448 "channelItem": { # The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem.
449 "resourceId": { # A resource id is a generic reference that points to another YouTube resource. # The resourceId object contains information that identifies the resource that was added to the channel.
450 "kind": "A String", # The kind, or type, of the referred resource.
451 "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.
452 "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.
453 "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]454 },
455 },
456 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]457 "kind": "youtube#activity", # The type of the API resource. For activity resources, the value will be youtube#activity.
458 "etag": "A String", # The ETag of the activity resource.
459 "id": "A String", # The ID that YouTube uses to uniquely identify the activity.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]460 },
461 ],
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]462 "etag": "A String", # The ETag of the response.
463 "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.
464 "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.
465 "totalResults": 42, # The total number of results in the result set.
466 "resultsPerPage": 42, # The number of results included in the API response.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]467 },
468 }</pre>
469</div>
470
471<div class="method">
472 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
473 <pre>Retrieves the next page of results.
474
475Args:
476 previous_request: The request for the previous page. (required)
477 previous_response: The response from the request for the previous page. (required)
478
479Returns:
480 A request object that you can call 'execute()' on to request the next
481 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]482 </pre>
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]483</div>
484
485</body></html>