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