Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4d50cd6883f37e19a26fabe3af6a75d407146520 / . / docs / dyn / plus_v1.activities.html
blob: 338d2678114c283b30aa99b4bc3ebdd5624619aa [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 {
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]120 "displayName": "A String", # The title of the attachment, such as a photo caption or an article title.
121 "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]122 {
123 "url": "A String", # URL to the webpage containing the image.
124 "image": { # Image resource.
125 "url": "A String", # Image url.
126 "width": 42, # The width, in pixels, of the linked resource.
127 "type": "A String", # Media type of the link.
128 "height": 42, # The height, in pixels, of the linked resource.
129 },
130 "description": "A String", # Potential name of the thumbnail.
131 },
132 ],
133 "fullImage": { # The full image URL for photo attachments.
134 "url": "A String", # URL to the image.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]135 "width": 42, # The width, in pixels, of the linked resource.
136 "type": "A String", # Media type of the link.
137 "height": 42, # The height, in pixels, of the linked resource.
138 },
139 "url": "A String", # The link to the attachment, should be of type text/html.
140 "image": { # The preview image for photos or videos.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]141 "url": "A String", # Image url.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]142 "width": 42, # The width, in pixels, of the linked resource.
143 "type": "A String", # Media type of the link.
144 "height": 42, # The height, in pixels, of the linked resource.
145 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]146 "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]147 "embed": { # If the attachment is a video, the embeddable link.
148 "url": "A String", # URL of the link.
149 "type": "A String", # Media type of the link.
150 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]151 "id": "A String", # The ID of the attachment.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]152 "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values:
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]153 # - "photo" - A photo.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]154 # - "album" - A photo album.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]155 # - "video" - A video.
156 # - "article" - An article, specified by a link.
157 },
158 ],
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]159 "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]160 "plusoners": { # People who +1'd this activity.
161 "totalItems": 42, # Total number of people who +1'd this activity.
162 "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
163 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]164 "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]165 "url": "A String", # A link to the original actor's Google profile.
166 "image": { # The image representation of the original actor.
167 "url": "A String", # A URL that points to a thumbnail photo of the original actor.
168 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]169 "displayName": "A String", # The original actor's name, which is suitable for display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]170 "id": "A String", # ID of the original actor.
171 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]172 "content": "A String", # The HTML-formatted content, which is suitable for display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]173 "url": "A String", # The URL that points to the linked resource.
174 "replies": { # Comments in reply to this activity.
175 "totalItems": 42, # Total number of comments on this activity.
176 "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
177 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]178 "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared.
179 "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values:
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]180 # - "note" - Textual content.
181 # - "activity" - A Google+ activity.
182 },
183 "placeId": "A String", # ID of the place where this activity occurred.
184 "actor": { # The person who performed this activity.
185 "url": "A String", # The link to the actor's Google profile.
186 "image": { # The image representation of the actor.
187 "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.
188 },
189 "displayName": "A String", # The name of the actor, suitable for display.
190 "id": "A String", # The ID of the actor's person resource.
191 "name": { # An object representation of the individual components of name.
192 "givenName": "A String", # The given name (first name) of the actor.
193 "familyName": "A String", # The family name (last name) of the actor.
194 },
195 },
196 "id": "A String", # The ID of this activity.
197 "access": { # Identifies who has access to see this activity.
198 "items": [ # The list of access entries.
199 {
200 "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
201 # - "person" - Access to an individual.
202 # - "circle" - Access to members of a circle.
203 # - "myCircles" - Access to members of all the person's circles.
204 # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]205 # - "domain" - Access to members of the person's Google Apps domain.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]206 # - "public" - Access to anyone on the web.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]207 "displayName": "A String", # A descriptive name for this entry. Suitable for display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]208 "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.
209 },
210 ],
211 "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
212 "description": "A String", # Description of the access granted, suitable for display.
213 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]214 "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values:
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]215 # - "post" - Publish content to the stream.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]216 # - "share" - Reshare an activity.
217 "etag": "A String", # ETag of this response for caching purposes.
218 "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]219 "location": { # The location where this activity occurred.
220 "position": { # The position of the place.
221 "latitude": 3.14, # The latitude of this position.
222 "longitude": 3.14, # The longitude of this position.
223 },
224 "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place".
225 "displayName": "A String", # The display name of the place.
226 "address": { # The physical address of the place.
227 "formatted": "A String", # The formatted address for display.
228 },
229 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]230 "address": "A String", # Street address where this activity occurred.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]231 "crosspostSource": "A String", # If this activity is a cross post from another system, this property specifies the ID of the original activity.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]232 "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
233 "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
234 }</pre>
235</div>
236
237<div class="method">
238 <code class="details" id="list">list(userId, collection, pageToken=None, maxResults=None)</code>
239 <pre>List all of the activities in the specified collection for a particular user.
240
241Args:
242 userId: string, The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. (required)
243 collection: string, The collection of activities to list. (required)
244 Allowed values
245 public - All public activities created by the specified user.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]246 pageToken: string, The continuation token, which is 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.
247 maxResults: integer, The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]248
249Returns:
250 An object of the form:
251
252 {
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]253 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]254 "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
255 "title": "A String", # The title of this collection of activities.
256 "items": [ # The activities in this page of results.
257 {
258 "placeName": "A String", # Name of the place where this activity occurred.
259 "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
260 "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
261 "provider": { # The service provider that initially published this activity.
262 "title": "A String", # Name of the service provider.
263 },
264 "title": "A String", # Title of this activity.
265 "url": "A String", # The link to this activity.
266 "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
267 "object": { # The object of this activity.
268 "resharers": { # People who reshared this activity.
269 "totalItems": 42, # Total number of people who reshared this activity.
270 "selfLink": "A String", # The URL for the collection of resharers.
271 },
272 "attachments": [ # The media objects attached to this activity.
273 {
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]274 "displayName": "A String", # The title of the attachment, such as a photo caption or an article title.
275 "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]276 {
277 "url": "A String", # URL to the webpage containing the image.
278 "image": { # Image resource.
279 "url": "A String", # Image url.
280 "width": 42, # The width, in pixels, of the linked resource.
281 "type": "A String", # Media type of the link.
282 "height": 42, # The height, in pixels, of the linked resource.
283 },
284 "description": "A String", # Potential name of the thumbnail.
285 },
286 ],
287 "fullImage": { # The full image URL for photo attachments.
288 "url": "A String", # URL to the image.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]289 "width": 42, # The width, in pixels, of the linked resource.
290 "type": "A String", # Media type of the link.
291 "height": 42, # The height, in pixels, of the linked resource.
292 },
293 "url": "A String", # The link to the attachment, should be of type text/html.
294 "image": { # The preview image for photos or videos.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]295 "url": "A String", # Image url.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]296 "width": 42, # The width, in pixels, of the linked resource.
297 "type": "A String", # Media type of the link.
298 "height": 42, # The height, in pixels, of the linked resource.
299 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]300 "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]301 "embed": { # If the attachment is a video, the embeddable link.
302 "url": "A String", # URL of the link.
303 "type": "A String", # Media type of the link.
304 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]305 "id": "A String", # The ID of the attachment.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]306 "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values:
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]307 # - "photo" - A photo.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]308 # - "album" - A photo album.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]309 # - "video" - A video.
310 # - "article" - An article, specified by a link.
311 },
312 ],
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]313 "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]314 "plusoners": { # People who +1'd this activity.
315 "totalItems": 42, # Total number of people who +1'd this activity.
316 "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
317 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]318 "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]319 "url": "A String", # A link to the original actor's Google profile.
320 "image": { # The image representation of the original actor.
321 "url": "A String", # A URL that points to a thumbnail photo of the original actor.
322 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]323 "displayName": "A String", # The original actor's name, which is suitable for display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]324 "id": "A String", # ID of the original actor.
325 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]326 "content": "A String", # The HTML-formatted content, which is suitable for display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]327 "url": "A String", # The URL that points to the linked resource.
328 "replies": { # Comments in reply to this activity.
329 "totalItems": 42, # Total number of comments on this activity.
330 "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
331 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]332 "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared.
333 "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values:
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]334 # - "note" - Textual content.
335 # - "activity" - A Google+ activity.
336 },
337 "placeId": "A String", # ID of the place where this activity occurred.
338 "actor": { # The person who performed this activity.
339 "url": "A String", # The link to the actor's Google profile.
340 "image": { # The image representation of the actor.
341 "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.
342 },
343 "displayName": "A String", # The name of the actor, suitable for display.
344 "id": "A String", # The ID of the actor's person resource.
345 "name": { # An object representation of the individual components of name.
346 "givenName": "A String", # The given name (first name) of the actor.
347 "familyName": "A String", # The family name (last name) of the actor.
348 },
349 },
350 "id": "A String", # The ID of this activity.
351 "access": { # Identifies who has access to see this activity.
352 "items": [ # The list of access entries.
353 {
354 "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
355 # - "person" - Access to an individual.
356 # - "circle" - Access to members of a circle.
357 # - "myCircles" - Access to members of all the person's circles.
358 # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]359 # - "domain" - Access to members of the person's Google Apps domain.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]360 # - "public" - Access to anyone on the web.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]361 "displayName": "A String", # A descriptive name for this entry. Suitable for display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]362 "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.
363 },
364 ],
365 "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
366 "description": "A String", # Description of the access granted, suitable for display.
367 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]368 "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values:
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]369 # - "post" - Publish content to the stream.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]370 # - "share" - Reshare an activity.
371 "etag": "A String", # ETag of this response for caching purposes.
372 "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]373 "location": { # The location where this activity occurred.
374 "position": { # The position of the place.
375 "latitude": 3.14, # The latitude of this position.
376 "longitude": 3.14, # The longitude of this position.
377 },
378 "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place".
379 "displayName": "A String", # The display name of the place.
380 "address": { # The physical address of the place.
381 "formatted": "A String", # The formatted address for display.
382 },
383 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]384 "address": "A String", # Street address where this activity occurred.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]385 "crosspostSource": "A String", # If this activity is a cross post from another system, this property specifies the ID of the original activity.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]386 "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
387 "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
388 },
389 ],
390 "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
391 "nextLink": "A String", # Link to the next page of activities.
392 "etag": "A String", # ETag of this response for caching purposes.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]393 "id": "A String", # The ID of this collection of activities. Deprecated.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]394 "selfLink": "A String", # Link to this activity resource.
395 }</pre>
396</div>
397
398<div class="method">
399 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
400 <pre>Retrieves the next page of results.
401
402Args:
403 previous_request: The request for the previous page. (required)
404 previous_response: The response from the request for the previous page. (required)
405
406Returns:
407 A request object that you can call 'execute()' on to request the next
408 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]409 </pre>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]410</div>
411
412<div class="method">
413 <code class="details" id="search">search(query, orderBy=None, language=None, pageToken=None, maxResults=None)</code>
414 <pre>Search public activities.
415
416Args:
417 query: string, Full-text search query string. (required)
418 orderBy: string, Specifies how to order search results.
419 Allowed values
420 best - Sort activities by relevance to the user, most relevant first.
421 recent - Sort activities by published date, most recent first.
422 language: string, Specify the preferred language to search with. See search language codes for available values.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]423 pageToken: string, The continuation token, which is 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 can be of any length.
424 maxResults: integer, The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]425
426Returns:
427 An object of the form:
428
429 {
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]430 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]431 "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
432 "title": "A String", # The title of this collection of activities.
433 "items": [ # The activities in this page of results.
434 {
435 "placeName": "A String", # Name of the place where this activity occurred.
436 "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
437 "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
438 "provider": { # The service provider that initially published this activity.
439 "title": "A String", # Name of the service provider.
440 },
441 "title": "A String", # Title of this activity.
442 "url": "A String", # The link to this activity.
443 "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
444 "object": { # The object of this activity.
445 "resharers": { # People who reshared this activity.
446 "totalItems": 42, # Total number of people who reshared this activity.
447 "selfLink": "A String", # The URL for the collection of resharers.
448 },
449 "attachments": [ # The media objects attached to this activity.
450 {
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]451 "displayName": "A String", # The title of the attachment, such as a photo caption or an article title.
452 "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]453 {
454 "url": "A String", # URL to the webpage containing the image.
455 "image": { # Image resource.
456 "url": "A String", # Image url.
457 "width": 42, # The width, in pixels, of the linked resource.
458 "type": "A String", # Media type of the link.
459 "height": 42, # The height, in pixels, of the linked resource.
460 },
461 "description": "A String", # Potential name of the thumbnail.
462 },
463 ],
464 "fullImage": { # The full image URL for photo attachments.
465 "url": "A String", # URL to the image.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]466 "width": 42, # The width, in pixels, of the linked resource.
467 "type": "A String", # Media type of the link.
468 "height": 42, # The height, in pixels, of the linked resource.
469 },
470 "url": "A String", # The link to the attachment, should be of type text/html.
471 "image": { # The preview image for photos or videos.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]472 "url": "A String", # Image url.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]473 "width": 42, # The width, in pixels, of the linked resource.
474 "type": "A String", # Media type of the link.
475 "height": 42, # The height, in pixels, of the linked resource.
476 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]477 "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]478 "embed": { # If the attachment is a video, the embeddable link.
479 "url": "A String", # URL of the link.
480 "type": "A String", # Media type of the link.
481 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]482 "id": "A String", # The ID of the attachment.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]483 "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values:
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]484 # - "photo" - A photo.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]485 # - "album" - A photo album.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]486 # - "video" - A video.
487 # - "article" - An article, specified by a link.
488 },
489 ],
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]490 "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]491 "plusoners": { # People who +1'd this activity.
492 "totalItems": 42, # Total number of people who +1'd this activity.
493 "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
494 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]495 "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]496 "url": "A String", # A link to the original actor's Google profile.
497 "image": { # The image representation of the original actor.
498 "url": "A String", # A URL that points to a thumbnail photo of the original actor.
499 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]500 "displayName": "A String", # The original actor's name, which is suitable for display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]501 "id": "A String", # ID of the original actor.
502 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]503 "content": "A String", # The HTML-formatted content, which is suitable for display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]504 "url": "A String", # The URL that points to the linked resource.
505 "replies": { # Comments in reply to this activity.
506 "totalItems": 42, # Total number of comments on this activity.
507 "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
508 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]509 "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared.
510 "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values:
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]511 # - "note" - Textual content.
512 # - "activity" - A Google+ activity.
513 },
514 "placeId": "A String", # ID of the place where this activity occurred.
515 "actor": { # The person who performed this activity.
516 "url": "A String", # The link to the actor's Google profile.
517 "image": { # The image representation of the actor.
518 "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.
519 },
520 "displayName": "A String", # The name of the actor, suitable for display.
521 "id": "A String", # The ID of the actor's person resource.
522 "name": { # An object representation of the individual components of name.
523 "givenName": "A String", # The given name (first name) of the actor.
524 "familyName": "A String", # The family name (last name) of the actor.
525 },
526 },
527 "id": "A String", # The ID of this activity.
528 "access": { # Identifies who has access to see this activity.
529 "items": [ # The list of access entries.
530 {
531 "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
532 # - "person" - Access to an individual.
533 # - "circle" - Access to members of a circle.
534 # - "myCircles" - Access to members of all the person's circles.
535 # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]536 # - "domain" - Access to members of the person's Google Apps domain.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]537 # - "public" - Access to anyone on the web.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]538 "displayName": "A String", # A descriptive name for this entry. Suitable for display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]539 "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.
540 },
541 ],
542 "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
543 "description": "A String", # Description of the access granted, suitable for display.
544 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]545 "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values:
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]546 # - "post" - Publish content to the stream.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]547 # - "share" - Reshare an activity.
548 "etag": "A String", # ETag of this response for caching purposes.
549 "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]550 "location": { # The location where this activity occurred.
551 "position": { # The position of the place.
552 "latitude": 3.14, # The latitude of this position.
553 "longitude": 3.14, # The longitude of this position.
554 },
555 "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place".
556 "displayName": "A String", # The display name of the place.
557 "address": { # The physical address of the place.
558 "formatted": "A String", # The formatted address for display.
559 },
560 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]561 "address": "A String", # Street address where this activity occurred.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]562 "crosspostSource": "A String", # If this activity is a cross post from another system, this property specifies the ID of the original activity.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]563 "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
564 "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
565 },
566 ],
567 "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
568 "nextLink": "A String", # Link to the next page of activities.
569 "etag": "A String", # ETag of this response for caching purposes.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]570 "id": "A String", # The ID of this collection of activities. Deprecated.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]571 "selfLink": "A String", # Link to this activity resource.
572 }</pre>
573</div>
574
575<div class="method">
576 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
577 <pre>Retrieves the next page of results.
578
579Args:
580 previous_request: The request for the previous page. (required)
581 previous_response: The response from the request for the previous page. (required)
582
583Returns:
584 A request object that you can call 'execute()' on to request the next
585 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]586 </pre>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]587</div>
588
589</body></html>