Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dc6c1efea8e6c89afa94df984d9291359cb04797 / . / docs / dyn / plus_v1.activities.html
blob: 386d1c6110f1ca08c205d9a4a723fa46dd332062 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
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.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]112 "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 {
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[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.
122 {
123 "url": "A String", # URL of 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 of the image.
John Asmuth614db982014-04-24 15:46:26 -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 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]139 "url": "A String", # The link to the attachment, which should be of type text/html.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]140 "image": { # The preview image for photos or videos.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]141 "url": "A String", # Image URL.
John Asmuth614db982014-04-24 15:46:26 -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 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[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.
John Asmuth614db982014-04-24 15:46:26 -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 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]151 "id": "A String", # The ID of the attachment.
152 "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]153 # - "photo" - A photo.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]154 # - "album" - A photo album.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 # - "video" - A video.
156 # - "article" - An article, specified by a link.
157 },
158 ],
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[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.
John Asmuth614db982014-04-24 15:46:26 -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 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[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.
165 "displayName": "A String", # The original actor's name, which is suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]166 "url": "A String", # A link to the original actor's Google profile.
167 "image": { # The image representation of the original actor.
168 "url": "A String", # A URL that points to a thumbnail photo of the original actor.
169 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]170 "clientSpecificActorInfo": { # Actor info specific to particular clients.
171 "youtubeActorInfo": { # Actor info specific to YouTube clients.
172 "channelId": "A String", # ID of the YouTube channel owned by the Actor.
173 },
174 },
175 "verification": { # Verification status of actor.
176 "adHocVerified": "A String", # Verification for one-time or manual processes.
177 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]178 "id": "A String", # ID of the original actor.
179 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]180 "content": "A String", # The HTML-formatted content, which is suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]181 "url": "A String", # The URL that points to the linked resource.
182 "replies": { # Comments in reply to this activity.
183 "totalItems": 42, # Total number of comments on this activity.
184 "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
185 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]186 "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared.
187 "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]188 # - "note" - Textual content.
189 # - "activity" - A Google+ activity.
190 },
191 "placeId": "A String", # ID of the place where this activity occurred.
192 "actor": { # The person who performed this activity.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]193 "displayName": "A String", # The name of the actor, suitable for display.
194 "name": { # An object representation of the individual components of name.
195 "givenName": "A String", # The given name ("first name") of the actor.
196 "familyName": "A String", # The family name ("last name") of the actor.
197 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]198 "url": "A String", # The link to the actor's Google profile.
199 "image": { # The image representation of the actor.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]200 "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]201 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]202 "clientSpecificActorInfo": { # Actor info specific to particular clients.
203 "youtubeActorInfo": { # Actor info specific to YouTube clients.
204 "channelId": "A String", # ID of the YouTube channel owned by the Actor.
205 },
206 },
207 "verification": { # Verification status of actor.
208 "adHocVerified": "A String", # Verification for one-time or manual processes.
209 },
210 "id": "A String", # The ID of the actor's Person resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]211 },
212 "id": "A String", # The ID of this activity.
213 "access": { # Identifies who has access to see this activity.
214 "items": [ # The list of access entries.
215 {
216 "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
217 # - "person" - Access to an individual.
218 # - "circle" - Access to members of a circle.
219 # - "myCircles" - Access to members of all the person's circles.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]220 # - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles.
221 # - "domain" - Access to members of the person's Google Apps domain.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]222 # - "public" - Access to anyone on the web.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]223 "displayName": "A String", # A descriptive name for this entry. Suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]224 "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.
225 },
226 ],
227 "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
228 "description": "A String", # Description of the access granted, suitable for display.
229 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]230 "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:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231 # - "post" - Publish content to the stream.
232 # - "share" - Reshare an activity.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]233 "etag": "A String", # ETag of this response for caching purposes.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]234 "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]235 "location": { # The location where this activity occurred.
236 "position": { # The position of the place.
237 "latitude": 3.14, # The latitude of this position.
238 "longitude": 3.14, # The longitude of this position.
239 },
240 "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place".
241 "displayName": "A String", # The display name of the place.
242 "id": "A String", # The id of the place.
243 "address": { # The physical address of the place.
244 "formatted": "A String", # The formatted address for display.
245 },
246 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]247 "address": "A String", # Street address where this activity occurred.
248 "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
249 "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
250 "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
251 }</pre>
252</div>
253
254<div class="method">
255 <code class="details" id="list">list(userId, collection, pageToken=None, maxResults=None)</code>
256 <pre>List all of the activities in the specified collection for a particular user.
257
258Args:
259 userId: string, The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. (required)
260 collection: string, The collection of activities to list. (required)
261 Allowed values
262 public - All public activities created by the specified user.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]263 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.
264 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]265
266Returns:
267 An object of the form:
268
269 {
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]270 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]271 "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]272 "title": "A String", # The title of this collection of activities, which is a truncated portion of the content.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]273 "items": [ # The activities in this page of results.
274 {
275 "placeName": "A String", # Name of the place where this activity occurred.
276 "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
277 "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
278 "provider": { # The service provider that initially published this activity.
279 "title": "A String", # Name of the service provider.
280 },
281 "title": "A String", # Title of this activity.
282 "url": "A String", # The link to this activity.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]283 "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]284 "object": { # The object of this activity.
285 "resharers": { # People who reshared this activity.
286 "totalItems": 42, # Total number of people who reshared this activity.
287 "selfLink": "A String", # The URL for the collection of resharers.
288 },
289 "attachments": [ # The media objects attached to this activity.
290 {
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]291 "displayName": "A String", # The title of the attachment, such as a photo caption or an article title.
292 "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album.
293 {
294 "url": "A String", # URL of the webpage containing the image.
295 "image": { # Image resource.
296 "url": "A String", # Image url.
297 "width": 42, # The width, in pixels, of the linked resource.
298 "type": "A String", # Media type of the link.
299 "height": 42, # The height, in pixels, of the linked resource.
300 },
301 "description": "A String", # Potential name of the thumbnail.
302 },
303 ],
304 "fullImage": { # The full image URL for photo attachments.
305 "url": "A String", # URL of the image.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]306 "width": 42, # The width, in pixels, of the linked resource.
307 "type": "A String", # Media type of the link.
308 "height": 42, # The height, in pixels, of the linked resource.
309 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]310 "url": "A String", # The link to the attachment, which should be of type text/html.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]311 "image": { # The preview image for photos or videos.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]312 "url": "A String", # Image URL.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]313 "width": 42, # The width, in pixels, of the linked resource.
314 "type": "A String", # Media type of the link.
315 "height": 42, # The height, in pixels, of the linked resource.
316 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]317 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]318 "embed": { # If the attachment is a video, the embeddable link.
319 "url": "A String", # URL of the link.
320 "type": "A String", # Media type of the link.
321 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]322 "id": "A String", # The ID of the attachment.
323 "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]324 # - "photo" - A photo.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]325 # - "album" - A photo album.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]326 # - "video" - A video.
327 # - "article" - An article, specified by a link.
328 },
329 ],
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]330 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]331 "plusoners": { # People who +1'd this activity.
332 "totalItems": 42, # Total number of people who +1'd this activity.
333 "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
334 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]335 "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.
336 "displayName": "A String", # The original actor's name, which is suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]337 "url": "A String", # A link to the original actor's Google profile.
338 "image": { # The image representation of the original actor.
339 "url": "A String", # A URL that points to a thumbnail photo of the original actor.
340 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]341 "clientSpecificActorInfo": { # Actor info specific to particular clients.
342 "youtubeActorInfo": { # Actor info specific to YouTube clients.
343 "channelId": "A String", # ID of the YouTube channel owned by the Actor.
344 },
345 },
346 "verification": { # Verification status of actor.
347 "adHocVerified": "A String", # Verification for one-time or manual processes.
348 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]349 "id": "A String", # ID of the original actor.
350 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]351 "content": "A String", # The HTML-formatted content, which is suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]352 "url": "A String", # The URL that points to the linked resource.
353 "replies": { # Comments in reply to this activity.
354 "totalItems": 42, # Total number of comments on this activity.
355 "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
356 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]357 "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared.
358 "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]359 # - "note" - Textual content.
360 # - "activity" - A Google+ activity.
361 },
362 "placeId": "A String", # ID of the place where this activity occurred.
363 "actor": { # The person who performed this activity.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]364 "displayName": "A String", # The name of the actor, suitable for display.
365 "name": { # An object representation of the individual components of name.
366 "givenName": "A String", # The given name ("first name") of the actor.
367 "familyName": "A String", # The family name ("last name") of the actor.
368 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]369 "url": "A String", # The link to the actor's Google profile.
370 "image": { # The image representation of the actor.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]371 "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]372 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]373 "clientSpecificActorInfo": { # Actor info specific to particular clients.
374 "youtubeActorInfo": { # Actor info specific to YouTube clients.
375 "channelId": "A String", # ID of the YouTube channel owned by the Actor.
376 },
377 },
378 "verification": { # Verification status of actor.
379 "adHocVerified": "A String", # Verification for one-time or manual processes.
380 },
381 "id": "A String", # The ID of the actor's Person resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]382 },
383 "id": "A String", # The ID of this activity.
384 "access": { # Identifies who has access to see this activity.
385 "items": [ # The list of access entries.
386 {
387 "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
388 # - "person" - Access to an individual.
389 # - "circle" - Access to members of a circle.
390 # - "myCircles" - Access to members of all the person's circles.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]391 # - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles.
392 # - "domain" - Access to members of the person's Google Apps domain.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]393 # - "public" - Access to anyone on the web.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]394 "displayName": "A String", # A descriptive name for this entry. Suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]395 "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.
396 },
397 ],
398 "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
399 "description": "A String", # Description of the access granted, suitable for display.
400 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]401 "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:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]402 # - "post" - Publish content to the stream.
403 # - "share" - Reshare an activity.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]404 "etag": "A String", # ETag of this response for caching purposes.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]405 "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]406 "location": { # The location where this activity occurred.
407 "position": { # The position of the place.
408 "latitude": 3.14, # The latitude of this position.
409 "longitude": 3.14, # The longitude of this position.
410 },
411 "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place".
412 "displayName": "A String", # The display name of the place.
413 "id": "A String", # The id of the place.
414 "address": { # The physical address of the place.
415 "formatted": "A String", # The formatted address for display.
416 },
417 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]418 "address": "A String", # Street address where this activity occurred.
419 "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
420 "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
421 "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
422 },
423 ],
424 "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
425 "nextLink": "A String", # Link to the next page of activities.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]426 "etag": "A String", # ETag of this response for caching purposes.
427 "id": "A String", # The ID of this collection of activities. Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]428 "selfLink": "A String", # Link to this activity resource.
429 }</pre>
430</div>
431
432<div class="method">
433 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
434 <pre>Retrieves the next page of results.
435
436Args:
437 previous_request: The request for the previous page. (required)
438 previous_response: The response from the request for the previous page. (required)
439
440Returns:
441 A request object that you can call 'execute()' on to request the next
442 page. Returns None if there are no more items in the collection.
443 </pre>
444</div>
445
446<div class="method">
447 <code class="details" id="search">search(query, orderBy=None, language=None, pageToken=None, maxResults=None)</code>
448 <pre>Search public activities.
449
450Args:
451 query: string, Full-text search query string. (required)
452 orderBy: string, Specifies how to order search results.
453 Allowed values
454 best - Sort activities by relevance to the user, most relevant first.
455 recent - Sort activities by published date, most recent first.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]456 language: string, Specify the preferred language to search with. See search language codes for available values.
457 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.
458 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]459
460Returns:
461 An object of the form:
462
463 {
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]464 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]465 "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]466 "title": "A String", # The title of this collection of activities, which is a truncated portion of the content.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]467 "items": [ # The activities in this page of results.
468 {
469 "placeName": "A String", # Name of the place where this activity occurred.
470 "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
471 "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
472 "provider": { # The service provider that initially published this activity.
473 "title": "A String", # Name of the service provider.
474 },
475 "title": "A String", # Title of this activity.
476 "url": "A String", # The link to this activity.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]477 "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]478 "object": { # The object of this activity.
479 "resharers": { # People who reshared this activity.
480 "totalItems": 42, # Total number of people who reshared this activity.
481 "selfLink": "A String", # The URL for the collection of resharers.
482 },
483 "attachments": [ # The media objects attached to this activity.
484 {
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]485 "displayName": "A String", # The title of the attachment, such as a photo caption or an article title.
486 "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album.
487 {
488 "url": "A String", # URL of the webpage containing the image.
489 "image": { # Image resource.
490 "url": "A String", # Image url.
491 "width": 42, # The width, in pixels, of the linked resource.
492 "type": "A String", # Media type of the link.
493 "height": 42, # The height, in pixels, of the linked resource.
494 },
495 "description": "A String", # Potential name of the thumbnail.
496 },
497 ],
498 "fullImage": { # The full image URL for photo attachments.
499 "url": "A String", # URL of the image.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]500 "width": 42, # The width, in pixels, of the linked resource.
501 "type": "A String", # Media type of the link.
502 "height": 42, # The height, in pixels, of the linked resource.
503 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]504 "url": "A String", # The link to the attachment, which should be of type text/html.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]505 "image": { # The preview image for photos or videos.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]506 "url": "A String", # Image URL.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]507 "width": 42, # The width, in pixels, of the linked resource.
508 "type": "A String", # Media type of the link.
509 "height": 42, # The height, in pixels, of the linked resource.
510 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]511 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]512 "embed": { # If the attachment is a video, the embeddable link.
513 "url": "A String", # URL of the link.
514 "type": "A String", # Media type of the link.
515 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]516 "id": "A String", # The ID of the attachment.
517 "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]518 # - "photo" - A photo.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]519 # - "album" - A photo album.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]520 # - "video" - A video.
521 # - "article" - An article, specified by a link.
522 },
523 ],
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]524 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]525 "plusoners": { # People who +1'd this activity.
526 "totalItems": 42, # Total number of people who +1'd this activity.
527 "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
528 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]529 "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.
530 "displayName": "A String", # The original actor's name, which is suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]531 "url": "A String", # A link to the original actor's Google profile.
532 "image": { # The image representation of the original actor.
533 "url": "A String", # A URL that points to a thumbnail photo of the original actor.
534 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]535 "clientSpecificActorInfo": { # Actor info specific to particular clients.
536 "youtubeActorInfo": { # Actor info specific to YouTube clients.
537 "channelId": "A String", # ID of the YouTube channel owned by the Actor.
538 },
539 },
540 "verification": { # Verification status of actor.
541 "adHocVerified": "A String", # Verification for one-time or manual processes.
542 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]543 "id": "A String", # ID of the original actor.
544 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]545 "content": "A String", # The HTML-formatted content, which is suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]546 "url": "A String", # The URL that points to the linked resource.
547 "replies": { # Comments in reply to this activity.
548 "totalItems": 42, # Total number of comments on this activity.
549 "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
550 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]551 "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared.
552 "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]553 # - "note" - Textual content.
554 # - "activity" - A Google+ activity.
555 },
556 "placeId": "A String", # ID of the place where this activity occurred.
557 "actor": { # The person who performed this activity.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]558 "displayName": "A String", # The name of the actor, suitable for display.
559 "name": { # An object representation of the individual components of name.
560 "givenName": "A String", # The given name ("first name") of the actor.
561 "familyName": "A String", # The family name ("last name") of the actor.
562 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]563 "url": "A String", # The link to the actor's Google profile.
564 "image": { # The image representation of the actor.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]565 "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]566 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]567 "clientSpecificActorInfo": { # Actor info specific to particular clients.
568 "youtubeActorInfo": { # Actor info specific to YouTube clients.
569 "channelId": "A String", # ID of the YouTube channel owned by the Actor.
570 },
571 },
572 "verification": { # Verification status of actor.
573 "adHocVerified": "A String", # Verification for one-time or manual processes.
574 },
575 "id": "A String", # The ID of the actor's Person resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]576 },
577 "id": "A String", # The ID of this activity.
578 "access": { # Identifies who has access to see this activity.
579 "items": [ # The list of access entries.
580 {
581 "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
582 # - "person" - Access to an individual.
583 # - "circle" - Access to members of a circle.
584 # - "myCircles" - Access to members of all the person's circles.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]585 # - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles.
586 # - "domain" - Access to members of the person's Google Apps domain.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]587 # - "public" - Access to anyone on the web.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]588 "displayName": "A String", # A descriptive name for this entry. Suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]589 "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.
590 },
591 ],
592 "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
593 "description": "A String", # Description of the access granted, suitable for display.
594 },
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]595 "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:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]596 # - "post" - Publish content to the stream.
597 # - "share" - Reshare an activity.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]598 "etag": "A String", # ETag of this response for caching purposes.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]599 "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]600 "location": { # The location where this activity occurred.
601 "position": { # The position of the place.
602 "latitude": 3.14, # The latitude of this position.
603 "longitude": 3.14, # The longitude of this position.
604 },
605 "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place".
606 "displayName": "A String", # The display name of the place.
607 "id": "A String", # The id of the place.
608 "address": { # The physical address of the place.
609 "formatted": "A String", # The formatted address for display.
610 },
611 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]612 "address": "A String", # Street address where this activity occurred.
613 "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
614 "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
615 "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
616 },
617 ],
618 "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
619 "nextLink": "A String", # Link to the next page of activities.
Jon Wayne Parrottdc6c1ef2016-10-14 11:04:30 -0700[diff] [blame^]620 "etag": "A String", # ETag of this response for caching purposes.
621 "id": "A String", # The ID of this collection of activities. Deprecated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]622 "selfLink": "A String", # Link to this activity resource.
623 }</pre>
624</div>
625
626<div class="method">
627 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
628 <pre>Retrieves the next page of results.
629
630Args:
631 previous_request: The request for the previous page. (required)
632 previous_response: The response from the request for the previous page. (required)
633
634Returns:
635 A request object that you can call 'execute()' on to request the next
636 page. Returns None if there are no more items in the collection.
637 </pre>
638</div>
639
640</body></html>