Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 46a8071fe1d1a112dcc791f61c20fd8306b4061f / . / docs / dyn / plus_v1.activities.html
blob: d52a12b2666e48b66c53c4e7d41cc4ac55f7be94 [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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]112 "object": { # The object of this activity.
113 "resharers": { # People who reshared this activity.
114 "totalItems": 42, # Total number of people who reshared this activity.
115 "selfLink": "A String", # The URL for the collection of resharers.
116 },
117 "attachments": [ # The media objects attached to this activity.
118 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]119 "displayName": "A String", # The title of the attachment (such as a photo caption or an article title).
120 "contentsource": { # If the attachment is audio, the link to the content.
121 "url": "A String", # URL of the link.
122 "type": "A String", # Media type of the link.
123 },
124 "fullImage": { # The full image url for photo attachments.
125 "url": "A String", # URL of the link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]130 "url": "A String", # The link to the attachment, should be of type text/html.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]131 "image": { # The preview image for photos or videos.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]132 "url": "A String", # URL of the link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]133 "width": 42, # The width, in pixels, of the linked resource.
134 "type": "A String", # Media type of the link.
135 "height": 42, # The height, in pixels, of the linked resource.
136 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]137 "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]138 "embed": { # If the attachment is a video, the embeddable link.
139 "url": "A String", # URL of the link.
140 "type": "A String", # Media type of the link.
141 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]142 "id": "A String", # The ID of the media object's resource.
143 "categories": [ # Specifies zero or more categories the attachment belongs to.
144 {
145 "term": "A String", # The tag, e.g. album.
146 "schema": "A String", # Domain of schema, e.g. http://google.com.
147 "label": "A String", # The category label, suitable for display (e.g. "album cover").
148 },
149 ],
150 "objectType": "A String", # The type of media object. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]151 # - "photo" - A photo.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]152 # - "video" - A video.
153 # - "article" - An article, specified by a link.
154 },
155 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]156 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]157 "plusoners": { # People who +1'd this activity.
158 "totalItems": 42, # Total number of people who +1'd this activity.
159 "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
160 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]161 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]162 "url": "A String", # A link to the original actor's Google profile.
163 "image": { # The image representation of the original actor.
164 "url": "A String", # A URL that points to a thumbnail photo of the original actor.
165 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]166 "displayName": "A String", # The original actor's name, suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]167 "id": "A String", # ID of the original actor.
168 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]169 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]170 "url": "A String", # The URL that points to the linked resource.
171 "replies": { # Comments in reply to this activity.
172 "totalItems": 42, # Total number of comments on this activity.
173 "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
174 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]175 "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared.
176 "objectType": "A String", # The type of the object. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]177 # - "note" - Textual content.
178 # - "activity" - A Google+ activity.
179 },
180 "placeId": "A String", # ID of the place where this activity occurred.
181 "actor": { # The person who performed this activity.
182 "url": "A String", # The link to the actor's Google profile.
183 "image": { # The image representation of the actor.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]184 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]185 },
186 "displayName": "A String", # The name of the actor, suitable for display.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]187 "id": "A String", # The ID of the actor's person resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]188 },
189 "id": "A String", # The ID of this activity.
190 "access": { # Identifies who has access to see this activity.
191 "items": [ # The list of access entries.
192 {
193 "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
194 # - "person" - Access to an individual.
195 # - "circle" - Access to members of a circle.
196 # - "myCircles" - Access to members of all the person's circles.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]197 # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]198 # - "public" - Access to anyone on the web.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]199 "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.
200 },
201 ],
202 "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
203 "description": "A String", # Description of the access granted, suitable for display.
204 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]205 "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]206 # - "post" - Publish content to the stream.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]207 # - "checkin" - Check in to a location.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]208 # - "share" - Reshare an activity.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]209 "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]210 "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]211 "address": "A String", # Street address where this activity occurred.
212 "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]213 "placeholder": True or False, # True if this activity is a placeholder.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]214 "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
215 "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
216 }</pre>
217</div>
218
219<div class="method">
220 <code class="details" id="list">list(userId, collection, pageToken=None, maxResults=None)</code>
221 <pre>List all of the activities in the specified collection for a particular user.
222
223Args:
224 userId: string, The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. (required)
225 collection: string, The collection of activities to list. (required)
226 Allowed values
227 public - All public activities created by the specified user.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]228 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.
229 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]230
231Returns:
232 An object of the form:
233
234 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]235 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]236 "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]237 "title": "A String", # The title of this collection of activities.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]238 "items": [ # The activities in this page of results.
239 {
240 "placeName": "A String", # Name of the place where this activity occurred.
241 "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
242 "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
243 "provider": { # The service provider that initially published this activity.
244 "title": "A String", # Name of the service provider.
245 },
246 "title": "A String", # Title of this activity.
247 "url": "A String", # The link to this activity.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]248 "object": { # The object of this activity.
249 "resharers": { # People who reshared this activity.
250 "totalItems": 42, # Total number of people who reshared this activity.
251 "selfLink": "A String", # The URL for the collection of resharers.
252 },
253 "attachments": [ # The media objects attached to this activity.
254 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]255 "displayName": "A String", # The title of the attachment (such as a photo caption or an article title).
256 "contentsource": { # If the attachment is audio, the link to the content.
257 "url": "A String", # URL of the link.
258 "type": "A String", # Media type of the link.
259 },
260 "fullImage": { # The full image url for photo attachments.
261 "url": "A String", # URL of the link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]262 "width": 42, # The width, in pixels, of the linked resource.
263 "type": "A String", # Media type of the link.
264 "height": 42, # The height, in pixels, of the linked resource.
265 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]266 "url": "A String", # The link to the attachment, should be of type text/html.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]267 "image": { # The preview image for photos or videos.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]268 "url": "A String", # URL of the link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]269 "width": 42, # The width, in pixels, of the linked resource.
270 "type": "A String", # Media type of the link.
271 "height": 42, # The height, in pixels, of the linked resource.
272 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]273 "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]274 "embed": { # If the attachment is a video, the embeddable link.
275 "url": "A String", # URL of the link.
276 "type": "A String", # Media type of the link.
277 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]278 "id": "A String", # The ID of the media object's resource.
279 "categories": [ # Specifies zero or more categories the attachment belongs to.
280 {
281 "term": "A String", # The tag, e.g. album.
282 "schema": "A String", # Domain of schema, e.g. http://google.com.
283 "label": "A String", # The category label, suitable for display (e.g. "album cover").
284 },
285 ],
286 "objectType": "A String", # The type of media object. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]287 # - "photo" - A photo.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]288 # - "video" - A video.
289 # - "article" - An article, specified by a link.
290 },
291 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]292 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]293 "plusoners": { # People who +1'd this activity.
294 "totalItems": 42, # Total number of people who +1'd this activity.
295 "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
296 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]297 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]298 "url": "A String", # A link to the original actor's Google profile.
299 "image": { # The image representation of the original actor.
300 "url": "A String", # A URL that points to a thumbnail photo of the original actor.
301 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]302 "displayName": "A String", # The original actor's name, suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]303 "id": "A String", # ID of the original actor.
304 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]305 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]306 "url": "A String", # The URL that points to the linked resource.
307 "replies": { # Comments in reply to this activity.
308 "totalItems": 42, # Total number of comments on this activity.
309 "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
310 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]311 "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared.
312 "objectType": "A String", # The type of the object. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]313 # - "note" - Textual content.
314 # - "activity" - A Google+ activity.
315 },
316 "placeId": "A String", # ID of the place where this activity occurred.
317 "actor": { # The person who performed this activity.
318 "url": "A String", # The link to the actor's Google profile.
319 "image": { # The image representation of the actor.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]320 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]321 },
322 "displayName": "A String", # The name of the actor, suitable for display.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]323 "id": "A String", # The ID of the actor's person resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]324 },
325 "id": "A String", # The ID of this activity.
326 "access": { # Identifies who has access to see this activity.
327 "items": [ # The list of access entries.
328 {
329 "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
330 # - "person" - Access to an individual.
331 # - "circle" - Access to members of a circle.
332 # - "myCircles" - Access to members of all the person's circles.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]333 # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]334 # - "public" - Access to anyone on the web.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]335 "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.
336 },
337 ],
338 "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
339 "description": "A String", # Description of the access granted, suitable for display.
340 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]341 "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]342 # - "post" - Publish content to the stream.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]343 # - "checkin" - Check in to a location.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]344 # - "share" - Reshare an activity.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]345 "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]346 "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]347 "address": "A String", # Street address where this activity occurred.
348 "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]349 "placeholder": True or False, # True if this activity is a placeholder.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]350 "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
351 "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
352 },
353 ],
354 "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
355 "nextLink": "A String", # Link to the next page of activities.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]356 "id": "A String", # The ID of this collection of activities.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]357 "selfLink": "A String", # Link to this activity resource.
358 }</pre>
359</div>
360
361<div class="method">
362 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
363 <pre>Retrieves the next page of results.
364
365Args:
366 previous_request: The request for the previous page. (required)
367 previous_response: The response from the request for the previous page. (required)
368
369Returns:
370 A request object that you can call 'execute()' on to request the next
371 page. Returns None if there are no more items in the collection.
372 </pre>
373</div>
374
375<div class="method">
376 <code class="details" id="search">search(query, orderBy=None, language=None, pageToken=None, maxResults=None)</code>
377 <pre>Search public activities.
378
379Args:
380 query: string, Full-text search query string. (required)
381 orderBy: string, Specifies how to order search results.
382 Allowed values
383 best - Sort activities by relevance to the user, most relevant first.
384 recent - Sort activities by published date, most recent first.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]385 language: string, Specify the preferred language to search with. See Language Codes for available values.
386 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.
387 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]388
389Returns:
390 An object of the form:
391
392 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]393 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]394 "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed".
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]395 "title": "A String", # The title of this collection of activities.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]396 "items": [ # The activities in this page of results.
397 {
398 "placeName": "A String", # Name of the place where this activity occurred.
399 "kind": "plus#activity", # Identifies this resource as an activity. Value: "plus#activity".
400 "updated": "A String", # The time at which this activity was last updated. Formatted as an RFC 3339 timestamp.
401 "provider": { # The service provider that initially published this activity.
402 "title": "A String", # Name of the service provider.
403 },
404 "title": "A String", # Title of this activity.
405 "url": "A String", # The link to this activity.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]406 "object": { # The object of this activity.
407 "resharers": { # People who reshared this activity.
408 "totalItems": 42, # Total number of people who reshared this activity.
409 "selfLink": "A String", # The URL for the collection of resharers.
410 },
411 "attachments": [ # The media objects attached to this activity.
412 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]413 "displayName": "A String", # The title of the attachment (such as a photo caption or an article title).
414 "contentsource": { # If the attachment is audio, the link to the content.
415 "url": "A String", # URL of the link.
416 "type": "A String", # Media type of the link.
417 },
418 "fullImage": { # The full image url for photo attachments.
419 "url": "A String", # URL of the link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]420 "width": 42, # The width, in pixels, of the linked resource.
421 "type": "A String", # Media type of the link.
422 "height": 42, # The height, in pixels, of the linked resource.
423 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]424 "url": "A String", # The link to the attachment, should be of type text/html.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]425 "image": { # The preview image for photos or videos.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]426 "url": "A String", # URL of the link.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]427 "width": 42, # The width, in pixels, of the linked resource.
428 "type": "A String", # Media type of the link.
429 "height": 42, # The height, in pixels, of the linked resource.
430 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]431 "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]432 "embed": { # If the attachment is a video, the embeddable link.
433 "url": "A String", # URL of the link.
434 "type": "A String", # Media type of the link.
435 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]436 "id": "A String", # The ID of the media object's resource.
437 "categories": [ # Specifies zero or more categories the attachment belongs to.
438 {
439 "term": "A String", # The tag, e.g. album.
440 "schema": "A String", # Domain of schema, e.g. http://google.com.
441 "label": "A String", # The category label, suitable for display (e.g. "album cover").
442 },
443 ],
444 "objectType": "A String", # The type of media object. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]445 # - "photo" - A photo.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]446 # - "video" - A video.
447 # - "article" - An article, specified by a link.
448 },
449 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]450 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]451 "plusoners": { # People who +1'd this activity.
452 "totalItems": 42, # Total number of people who +1'd this activity.
453 "selfLink": "A String", # The URL for the collection of people who +1'd this activity.
454 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]455 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]456 "url": "A String", # A link to the original actor's Google profile.
457 "image": { # The image representation of the original actor.
458 "url": "A String", # A URL that points to a thumbnail photo of the original actor.
459 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]460 "displayName": "A String", # The original actor's name, suitable for display.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]461 "id": "A String", # ID of the original actor.
462 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]463 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]464 "url": "A String", # The URL that points to the linked resource.
465 "replies": { # Comments in reply to this activity.
466 "totalItems": 42, # Total number of comments on this activity.
467 "selfLink": "A String", # The URL for the collection of comments in reply to this activity.
468 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]469 "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared.
470 "objectType": "A String", # The type of the object. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]471 # - "note" - Textual content.
472 # - "activity" - A Google+ activity.
473 },
474 "placeId": "A String", # ID of the place where this activity occurred.
475 "actor": { # The person who performed this activity.
476 "url": "A String", # The link to the actor's Google profile.
477 "image": { # The image representation of the actor.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]478 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]479 },
480 "displayName": "A String", # The name of the actor, suitable for display.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]481 "id": "A String", # The ID of the actor's person resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]482 },
483 "id": "A String", # The ID of this activity.
484 "access": { # Identifies who has access to see this activity.
485 "items": [ # The list of access entries.
486 {
487 "type": "A String", # The type of entry describing to whom access is granted. Possible values are:
488 # - "person" - Access to an individual.
489 # - "circle" - Access to members of a circle.
490 # - "myCircles" - Access to members of all the person's circles.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]491 # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]492 # - "public" - Access to anyone on the web.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]493 "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.
494 },
495 ],
496 "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl".
497 "description": "A String", # Description of the access granted, suitable for display.
498 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]499 "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]500 # - "post" - Publish content to the stream.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]501 # - "checkin" - Check in to a location.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]502 # - "share" - Reshare an activity.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]503 "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]504 "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]505 "address": "A String", # Street address where this activity occurred.
506 "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]507 "placeholder": True or False, # True if this activity is a placeholder.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]508 "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity.
509 "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp.
510 },
511 ],
512 "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp.
513 "nextLink": "A String", # Link to the next page of activities.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]514 "id": "A String", # The ID of this collection of activities.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]515 "selfLink": "A String", # Link to this activity resource.
516 }</pre>
517</div>
518
519<div class="method">
520 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
521 <pre>Retrieves the next page of results.
522
523Args:
524 previous_request: The request for the previous page. (required)
525 previous_response: The response from the request for the previous page. (required)
526
527Returns:
528 A request object that you can call 'execute()' on to request the next
529 page. Returns None if there are no more items in the collection.
530 </pre>
531</div>
532
533</body></html>