Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 075572b86b87d93810e12170f57bcbf72ab4c507 / . / docs / dyn / plus_v1.activities.html
blob: 7e3e8c312f9a753737b81bacd27460b0cc8aa326 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame^]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="plus_v1.html">Google+ API</a> . <a href="plus_v1.activities.html">activities</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(activityId)</a></code></p>
79<p class="firstline">Get an activity.</p>
80<p class="toc_element">
81 <code><a href="#list">list(userId, collection, pageToken=None, maxResults=None)</a></code></p>
82<p class="firstline">List all of the activities in the specified collection for a particular user.</p>
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<p class="toc_element">
87 <code><a href="#search">search(query, orderBy=None, language=None, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Search public activities.</p>
89<p class="toc_element">
90 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="get">get(activityId)</code>
95 <pre>Get an activity.
96
97Args:
98 activityId: string, The ID of the activity to get. (required)
99
100Returns:
101 An object of the form:
102
103 {
104 "placeName": "A String", # Name of the place where this activity occurred.
105 "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
106 "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
107 "provider": { # The service provider that initially published this activity.
108 "title": "A String", # Name of the service provider.
109 },
110 "title": "A String", # Title of this activity.
111 "url": "A String", # The link to this activity.
112 "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
113 "object": { # The object of this activity.
114 "resharers": { # People who reshared this activity.
115 "totalItems": 42, # Total number of people who reshared this activity.
116 "selfLink": "A String", # The URL for the collection of resharers.
117 },
118 "attachments": [ # The media objects attached to this activity.
119 {
120 "displayName": "A String", # The title of the attachment (such as a photo caption or an article title).
121 "fullImage": { # The full image url for photo attachments.
122 "url": "A String", # URL of the link.
123 "width": 42, # The width, in pixels, of the linked resource.
124 "type": "A String", # Media type of the link.
125 "height": 42, # The height, in pixels, of the linked resource.
126 },
127 "url": "A String", # The link to the attachment, should be of type text/html.
128 "image": { # The preview image for photos or videos.
129 "url": "A String", # URL of the link.
130 "width": 42, # The width, in pixels, of the linked resource.
131 "type": "A String", # Media type of the link.
132 "height": 42, # The height, in pixels, of the linked resource.
133 },
134 "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article.
135 "embed": { # If the attachment is a video, the embeddable link.
136 "url": "A String", # URL of the link.
137 "type": "A String", # Media type of the link.
138 },
139 "id": "A String", # The ID of the media object's resource.
140 "objectType": "A String", # The type of media object. Possible values are:
141 # - "photo" - A photo.
142 # - "video" - A video.
143 # - "article" - An article, specified by a link.
144 },
145 ],
146 "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits.
147 "plusoners": { # People who +1'd this activity.
148 "totalItems": 42, # Total number of people who +1'd this activity.
149 "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
150 },
151 "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor.
152 "url": "A String", # A link to the original actor's Google profile.
153 "image": { # The image representation of the original actor.
154 "url": "A String", # A URL that points to a thumbnail photo of the original actor.
155 },
156 "displayName": "A String", # The original actor's name, suitable for display.
157 "id": "A String", # ID of the original actor.
158 },
159 "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property.
160 "url": "A String", # The URL that points to the linked resource.
161 "replies": { # Comments in reply to this activity.
162 "totalItems": 42, # Total number of comments on this activity.
163 "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
164 },
165 "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared.
166 "objectType": "A String", # The type of the object. Possible values are:
167 # - "note" - Textual content.
168 # - "activity" - A Google+ activity.
169 },
170 "placeId": "A String", # ID of the place where this activity occurred.
171 "actor": { # The person who performed this activity.
172 "url": "A String", # The link to the actor's Google profile.
173 "image": { # The image representation of the actor.
174 "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
175 },
176 "displayName": "A String", # The name of the actor, suitable for display.
177 "id": "A String", # The ID of the actor's person resource.
178 "name": { # An object representation of the individual components of name.
179 "givenName": "A String", # The given name (first name) of the actor.
180 "familyName": "A String", # The family name (last name) of the actor.
181 },
182 },
183 "id": "A String", # The ID of this activity.
184 "access": { # Identifies who has access to see this activity.
185 "items": [ # The list of access entries.
186 {
187 "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
188 # - "person" - Access to an individual.
189 # - "circle" - Access to members of a circle.
190 # - "myCircles" - Access to members of all the person's circles.
191 # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
192 # - "public" - Access to anyone on the web.
193 "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
194 },
195 ],
196 "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
197 "description": "A String", # Description of the access granted, suitable for display.
198 },
199 "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
200 # - "post" - Publish content to the stream.
201 # - "checkin" - Check in to a location.
202 # - "share" - Reshare an activity.
203 "etag": "A String", # ETag of this response for caching purposes.
204 "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
205 "address": "A String", # Street address where this activity occurred.
206 "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
207 "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
208 "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
209 }</pre>
210</div>
211
212<div class="method">
213 <code class="details" id="list">list(userId, collection, pageToken=None, maxResults=None)</code>
214 <pre>List all of the activities in the specified collection for a particular user.
215
216Args:
217 userId: string, The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. (required)
218 collection: string, The collection of activities to list. (required)
219 Allowed values
220 public - All public activities created by the specified user.
221 pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
222 maxResults: integer, The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
223
224Returns:
225 An object of the form:
226
227 {
228 "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
229 "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
230 "title": "A String", # The title of this collection of activities.
231 "items": [ # The activities in this page of results.
232 {
233 "placeName": "A String", # Name of the place where this activity occurred.
234 "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
235 "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
236 "provider": { # The service provider that initially published this activity.
237 "title": "A String", # Name of the service provider.
238 },
239 "title": "A String", # Title of this activity.
240 "url": "A String", # The link to this activity.
241 "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
242 "object": { # The object of this activity.
243 "resharers": { # People who reshared this activity.
244 "totalItems": 42, # Total number of people who reshared this activity.
245 "selfLink": "A String", # The URL for the collection of resharers.
246 },
247 "attachments": [ # The media objects attached to this activity.
248 {
249 "displayName": "A String", # The title of the attachment (such as a photo caption or an article title).
250 "fullImage": { # The full image url for photo attachments.
251 "url": "A String", # URL of the link.
252 "width": 42, # The width, in pixels, of the linked resource.
253 "type": "A String", # Media type of the link.
254 "height": 42, # The height, in pixels, of the linked resource.
255 },
256 "url": "A String", # The link to the attachment, should be of type text/html.
257 "image": { # The preview image for photos or videos.
258 "url": "A String", # URL of the link.
259 "width": 42, # The width, in pixels, of the linked resource.
260 "type": "A String", # Media type of the link.
261 "height": 42, # The height, in pixels, of the linked resource.
262 },
263 "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article.
264 "embed": { # If the attachment is a video, the embeddable link.
265 "url": "A String", # URL of the link.
266 "type": "A String", # Media type of the link.
267 },
268 "id": "A String", # The ID of the media object's resource.
269 "objectType": "A String", # The type of media object. Possible values are:
270 # - "photo" - A photo.
271 # - "video" - A video.
272 # - "article" - An article, specified by a link.
273 },
274 ],
275 "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits.
276 "plusoners": { # People who +1'd this activity.
277 "totalItems": 42, # Total number of people who +1'd this activity.
278 "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
279 },
280 "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor.
281 "url": "A String", # A link to the original actor's Google profile.
282 "image": { # The image representation of the original actor.
283 "url": "A String", # A URL that points to a thumbnail photo of the original actor.
284 },
285 "displayName": "A String", # The original actor's name, suitable for display.
286 "id": "A String", # ID of the original actor.
287 },
288 "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property.
289 "url": "A String", # The URL that points to the linked resource.
290 "replies": { # Comments in reply to this activity.
291 "totalItems": 42, # Total number of comments on this activity.
292 "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
293 },
294 "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared.
295 "objectType": "A String", # The type of the object. Possible values are:
296 # - "note" - Textual content.
297 # - "activity" - A Google+ activity.
298 },
299 "placeId": "A String", # ID of the place where this activity occurred.
300 "actor": { # The person who performed this activity.
301 "url": "A String", # The link to the actor's Google profile.
302 "image": { # The image representation of the actor.
303 "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
304 },
305 "displayName": "A String", # The name of the actor, suitable for display.
306 "id": "A String", # The ID of the actor's person resource.
307 "name": { # An object representation of the individual components of name.
308 "givenName": "A String", # The given name (first name) of the actor.
309 "familyName": "A String", # The family name (last name) of the actor.
310 },
311 },
312 "id": "A String", # The ID of this activity.
313 "access": { # Identifies who has access to see this activity.
314 "items": [ # The list of access entries.
315 {
316 "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
317 # - "person" - Access to an individual.
318 # - "circle" - Access to members of a circle.
319 # - "myCircles" - Access to members of all the person's circles.
320 # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
321 # - "public" - Access to anyone on the web.
322 "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
323 },
324 ],
325 "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
326 "description": "A String", # Description of the access granted, suitable for display.
327 },
328 "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
329 # - "post" - Publish content to the stream.
330 # - "checkin" - Check in to a location.
331 # - "share" - Reshare an activity.
332 "etag": "A String", # ETag of this response for caching purposes.
333 "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
334 "address": "A String", # Street address where this activity occurred.
335 "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
336 "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
337 "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
338 },
339 ],
340 "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
341 "nextLink": "A String", # Link to the next page of activities.
342 "etag": "A String", # ETag of this response for caching purposes.
343 "id": "A String", # The ID of this collection of activities.
344 "selfLink": "A String", # Link to this activity resource.
345 }</pre>
346</div>
347
348<div class="method">
349 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
350 <pre>Retrieves the next page of results.
351
352Args:
353 previous_request: The request for the previous page. (required)
354 previous_response: The response from the request for the previous page. (required)
355
356Returns:
357 A request object that you can call 'execute()' on to request the next
358 page. Returns None if there are no more items in the collection.
359 </pre>
360</div>
361
362<div class="method">
363 <code class="details" id="search">search(query, orderBy=None, language=None, pageToken=None, maxResults=None)</code>
364 <pre>Search public activities.
365
366Args:
367 query: string, Full-text search query string. (required)
368 orderBy: string, Specifies how to order search results.
369 Allowed values
370 best - Sort activities by relevance to the user, most relevant first.
371 recent - Sort activities by published date, most recent first.
372 language: string, Specify the preferred language to search with. See search language codes for available values.
373 pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.
374 maxResults: integer, The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
375
376Returns:
377 An object of the form:
378
379 {
380 "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
381 "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
382 "title": "A String", # The title of this collection of activities.
383 "items": [ # The activities in this page of results.
384 {
385 "placeName": "A String", # Name of the place where this activity occurred.
386 "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
387 "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
388 "provider": { # The service provider that initially published this activity.
389 "title": "A String", # Name of the service provider.
390 },
391 "title": "A String", # Title of this activity.
392 "url": "A String", # The link to this activity.
393 "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
394 "object": { # The object of this activity.
395 "resharers": { # People who reshared this activity.
396 "totalItems": 42, # Total number of people who reshared this activity.
397 "selfLink": "A String", # The URL for the collection of resharers.
398 },
399 "attachments": [ # The media objects attached to this activity.
400 {
401 "displayName": "A String", # The title of the attachment (such as a photo caption or an article title).
402 "fullImage": { # The full image url for photo attachments.
403 "url": "A String", # URL of the link.
404 "width": 42, # The width, in pixels, of the linked resource.
405 "type": "A String", # Media type of the link.
406 "height": 42, # The height, in pixels, of the linked resource.
407 },
408 "url": "A String", # The link to the attachment, should be of type text/html.
409 "image": { # The preview image for photos or videos.
410 "url": "A String", # URL of the link.
411 "width": 42, # The width, in pixels, of the linked resource.
412 "type": "A String", # Media type of the link.
413 "height": 42, # The height, in pixels, of the linked resource.
414 },
415 "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article.
416 "embed": { # If the attachment is a video, the embeddable link.
417 "url": "A String", # URL of the link.
418 "type": "A String", # Media type of the link.
419 },
420 "id": "A String", # The ID of the media object's resource.
421 "objectType": "A String", # The type of media object. Possible values are:
422 # - "photo" - A photo.
423 # - "video" - A video.
424 # - "article" - An article, specified by a link.
425 },
426 ],
427 "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits.
428 "plusoners": { # People who +1'd this activity.
429 "totalItems": 42, # Total number of people who +1'd this activity.
430 "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
431 },
432 "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor.
433 "url": "A String", # A link to the original actor's Google profile.
434 "image": { # The image representation of the original actor.
435 "url": "A String", # A URL that points to a thumbnail photo of the original actor.
436 },
437 "displayName": "A String", # The original actor's name, suitable for display.
438 "id": "A String", # ID of the original actor.
439 },
440 "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property.
441 "url": "A String", # The URL that points to the linked resource.
442 "replies": { # Comments in reply to this activity.
443 "totalItems": 42, # Total number of comments on this activity.
444 "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
445 },
446 "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared.
447 "objectType": "A String", # The type of the object. Possible values are:
448 # - "note" - Textual content.
449 # - "activity" - A Google+ activity.
450 },
451 "placeId": "A String", # ID of the place where this activity occurred.
452 "actor": { # The person who performed this activity.
453 "url": "A String", # The link to the actor's Google profile.
454 "image": { # The image representation of the actor.
455 "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
456 },
457 "displayName": "A String", # The name of the actor, suitable for display.
458 "id": "A String", # The ID of the actor's person resource.
459 "name": { # An object representation of the individual components of name.
460 "givenName": "A String", # The given name (first name) of the actor.
461 "familyName": "A String", # The family name (last name) of the actor.
462 },
463 },
464 "id": "A String", # The ID of this activity.
465 "access": { # Identifies who has access to see this activity.
466 "items": [ # The list of access entries.
467 {
468 "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
469 # - "person" - Access to an individual.
470 # - "circle" - Access to members of a circle.
471 # - "myCircles" - Access to members of all the person's circles.
472 # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
473 # - "public" - Access to anyone on the web.
474 "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set.
475 },
476 ],
477 "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
478 "description": "A String", # Description of the access granted, suitable for display.
479 },
480 "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
481 # - "post" - Publish content to the stream.
482 # - "checkin" - Check in to a location.
483 # - "share" - Reshare an activity.
484 "etag": "A String", # ETag of this response for caching purposes.
485 "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
486 "address": "A String", # Street address where this activity occurred.
487 "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
488 "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
489 "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
490 },
491 ],
492 "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
493 "nextLink": "A String", # Link to the next page of activities.
494 "etag": "A String", # ETag of this response for caching purposes.
495 "id": "A String", # The ID of this collection of activities.
496 "selfLink": "A String", # Link to this activity resource.
497 }</pre>
498</div>
499
500<div class="method">
501 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
502 <pre>Retrieves the next page of results.
503
504Args:
505 previous_request: The request for the previous page. (required)
506 previous_response: The response from the request for the previous page. (required)
507
508Returns:
509 A request object that you can call 'execute()' on to request the next
510 page. Returns None if there are no more items in the collection.
511 </pre>
512</div>
513
514</body></html>