Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8ca72561c8f53f6a4acea8b51304d2bde095891e / . / docs / dyn / plus_v1.moments.html
blob: bcffab39cc067dd14912bbb7411b29d03e3beab3 [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.moments.html">moments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#insert">insert(userId, collection, body, debug=None)</a></code></p>
79<p class="firstline">Record a moment representing a user's activity such as making a purchase or commenting on a blog.</p>
80<p class="toc_element">
81 <code><a href="#list">list(userId, collection, pageToken=None, maxResults=None, targetUrl=None, type=None)</a></code></p>
82<p class="firstline">List all of the moments 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="#remove">remove(id)</a></code></p>
88<p class="firstline">Delete a moment.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="insert">insert(userId, collection, body, debug=None)</code>
92 <pre>Record a moment representing a user's activity such as making a purchase or commenting on a blog.
93
94Args:
95 userId: string, The ID of the user to record activities for. The only valid values are "me" and the ID of the authenticated user. (required)
96 collection: string, The collection to which to write moments. (required)
97 Allowed values
98 vault - The default collection for writing new moments.
99 body: object, The request body. (required)
100 The object takes the form of:
101
102{
103 "startDate": "A String", # Time stamp of when the action occurred in RFC3339 format.
104 "kind": "plus#moment", # Identifies this resource as a moment.
105 "target": { # The object on which the action was performed.
106 "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
107 "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
108 "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
109 "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
110 "address": # Object with schema name: ItemScope # Postal address.
111 "birthDate": "A String", # Date of birth.
112 "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
113 "addressLocality": "A String", # Address locality.
114 "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
115 "additionalName": [ # An additional name for a Person, can be used for a middle name.
116 "A String",
117 ],
118 "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
119 "contributor": [ # A list of contributors to this result.
120 # Object with schema name: ItemScope
121 ],
122 "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
123 "id": "A String", # An identifier for the target. Your app can choose how to identify targets. The target.id is required if you are writing an activity that does not have a corresponding web page or target.url property.
124 "postOfficeBoxNumber": "A String", # Post office box number.
125 "attendees": [ # A person attending the event.
126 # Object with schema name: ItemScope
127 ],
128 "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
129 # Object with schema name: ItemScope
130 ],
131 "associated_media": [ # The encoding.
132 # Object with schema name: ItemScope
133 ],
134 "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
135 "addressCountry": "A String", # Address country.
136 "width": "A String", # The width of the media object.
137 "streetAddress": "A String", # Street address.
138 "location": # Object with schema name: ItemScope # The location of the event or organization.
139 "latitude": 3.14, # Latitude.
140 "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
141 "type": "A String", # The schema.org URL that best describes the referenced target and matches the type of moment.
142 "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
143 "contentSize": "A String", # File size in (mega/kilo) bytes.
144 "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
145 "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
146 "description": "A String", # The string that describes the content of the result.
147 "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
148 "kind": "plus#itemScope", # Identifies this resource as an itemScope.
149 "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
150 "postalCode": "A String", # Postal code.
151 "attendeeCount": 42, # Number of attendees.
152 "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
153 "addressRegion": "A String", # Address region.
154 "height": "A String", # The height of the media object.
155 "geo": # Object with schema name: ItemScope # Geo coordinates.
156 "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
157 "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
158 "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
159 "about": # Object with schema name: ItemScope # The subject matter of the content.
160 "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
161 "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
162 "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
163 # Object with schema name: ItemScope
164 ],
165 "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
166 "gender": "A String", # Gender of the person.
167 "longitude": 3.14, # Longitude.
168 "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
169 "caption": "A String", # The caption for this object.
170 "ratingValue": "A String", # Rating value.
171 "reviewRating": # Object with schema name: ItemScope # Review rating.
172 "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
173 },
174 "result": { # The object generated by performing the action on the target. For example, a user writes a review of a restaurant, the target is the restaurant and the result is the review.
175 "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
176 "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
177 "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
178 "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
179 "address": # Object with schema name: ItemScope # Postal address.
180 "birthDate": "A String", # Date of birth.
181 "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
182 "addressLocality": "A String", # Address locality.
183 "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
184 "additionalName": [ # An additional name for a Person, can be used for a middle name.
185 "A String",
186 ],
187 "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
188 "contributor": [ # A list of contributors to this result.
189 # Object with schema name: ItemScope
190 ],
191 "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
192 "id": "A String", # An identifier for the target. Your app can choose how to identify targets. The target.id is required if you are writing an activity that does not have a corresponding web page or target.url property.
193 "postOfficeBoxNumber": "A String", # Post office box number.
194 "attendees": [ # A person attending the event.
195 # Object with schema name: ItemScope
196 ],
197 "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
198 # Object with schema name: ItemScope
199 ],
200 "associated_media": [ # The encoding.
201 # Object with schema name: ItemScope
202 ],
203 "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
204 "addressCountry": "A String", # Address country.
205 "width": "A String", # The width of the media object.
206 "streetAddress": "A String", # Street address.
207 "location": # Object with schema name: ItemScope # The location of the event or organization.
208 "latitude": 3.14, # Latitude.
209 "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
210 "type": "A String", # The schema.org URL that best describes the referenced target and matches the type of moment.
211 "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
212 "contentSize": "A String", # File size in (mega/kilo) bytes.
213 "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
214 "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
215 "description": "A String", # The string that describes the content of the result.
216 "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
217 "kind": "plus#itemScope", # Identifies this resource as an itemScope.
218 "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
219 "postalCode": "A String", # Postal code.
220 "attendeeCount": 42, # Number of attendees.
221 "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
222 "addressRegion": "A String", # Address region.
223 "height": "A String", # The height of the media object.
224 "geo": # Object with schema name: ItemScope # Geo coordinates.
225 "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
226 "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
227 "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
228 "about": # Object with schema name: ItemScope # The subject matter of the content.
229 "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
230 "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
231 "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
232 # Object with schema name: ItemScope
233 ],
234 "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
235 "gender": "A String", # Gender of the person.
236 "longitude": 3.14, # Longitude.
237 "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
238 "caption": "A String", # The caption for this object.
239 "ratingValue": "A String", # Rating value.
240 "reviewRating": # Object with schema name: ItemScope # Review rating.
241 "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
242 },
243 "type": "A String", # The Google schema for the type of moment to write. For example, http://schemas.google.com/AddActivity.
244 "id": "A String", # The moment ID.
245 }
246
247 debug: boolean, Return the moment as written. Should be used only for debugging.
248
249Returns:
250 An object of the form:
251
252 {
253 "startDate": "A String", # Time stamp of when the action occurred in RFC3339 format.
254 "kind": "plus#moment", # Identifies this resource as a moment.
255 "target": { # The object on which the action was performed.
256 "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
257 "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
258 "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
259 "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
260 "address": # Object with schema name: ItemScope # Postal address.
261 "birthDate": "A String", # Date of birth.
262 "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
263 "addressLocality": "A String", # Address locality.
264 "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
265 "additionalName": [ # An additional name for a Person, can be used for a middle name.
266 "A String",
267 ],
268 "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
269 "contributor": [ # A list of contributors to this result.
270 # Object with schema name: ItemScope
271 ],
272 "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
273 "id": "A String", # An identifier for the target. Your app can choose how to identify targets. The target.id is required if you are writing an activity that does not have a corresponding web page or target.url property.
274 "postOfficeBoxNumber": "A String", # Post office box number.
275 "attendees": [ # A person attending the event.
276 # Object with schema name: ItemScope
277 ],
278 "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
279 # Object with schema name: ItemScope
280 ],
281 "associated_media": [ # The encoding.
282 # Object with schema name: ItemScope
283 ],
284 "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
285 "addressCountry": "A String", # Address country.
286 "width": "A String", # The width of the media object.
287 "streetAddress": "A String", # Street address.
288 "location": # Object with schema name: ItemScope # The location of the event or organization.
289 "latitude": 3.14, # Latitude.
290 "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
291 "type": "A String", # The schema.org URL that best describes the referenced target and matches the type of moment.
292 "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
293 "contentSize": "A String", # File size in (mega/kilo) bytes.
294 "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
295 "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
296 "description": "A String", # The string that describes the content of the result.
297 "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
298 "kind": "plus#itemScope", # Identifies this resource as an itemScope.
299 "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
300 "postalCode": "A String", # Postal code.
301 "attendeeCount": 42, # Number of attendees.
302 "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
303 "addressRegion": "A String", # Address region.
304 "height": "A String", # The height of the media object.
305 "geo": # Object with schema name: ItemScope # Geo coordinates.
306 "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
307 "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
308 "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
309 "about": # Object with schema name: ItemScope # The subject matter of the content.
310 "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
311 "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
312 "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
313 # Object with schema name: ItemScope
314 ],
315 "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
316 "gender": "A String", # Gender of the person.
317 "longitude": 3.14, # Longitude.
318 "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
319 "caption": "A String", # The caption for this object.
320 "ratingValue": "A String", # Rating value.
321 "reviewRating": # Object with schema name: ItemScope # Review rating.
322 "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
323 },
324 "result": { # The object generated by performing the action on the target. For example, a user writes a review of a restaurant, the target is the restaurant and the result is the review.
325 "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
326 "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
327 "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
328 "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
329 "address": # Object with schema name: ItemScope # Postal address.
330 "birthDate": "A String", # Date of birth.
331 "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
332 "addressLocality": "A String", # Address locality.
333 "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
334 "additionalName": [ # An additional name for a Person, can be used for a middle name.
335 "A String",
336 ],
337 "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
338 "contributor": [ # A list of contributors to this result.
339 # Object with schema name: ItemScope
340 ],
341 "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
342 "id": "A String", # An identifier for the target. Your app can choose how to identify targets. The target.id is required if you are writing an activity that does not have a corresponding web page or target.url property.
343 "postOfficeBoxNumber": "A String", # Post office box number.
344 "attendees": [ # A person attending the event.
345 # Object with schema name: ItemScope
346 ],
347 "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
348 # Object with schema name: ItemScope
349 ],
350 "associated_media": [ # The encoding.
351 # Object with schema name: ItemScope
352 ],
353 "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
354 "addressCountry": "A String", # Address country.
355 "width": "A String", # The width of the media object.
356 "streetAddress": "A String", # Street address.
357 "location": # Object with schema name: ItemScope # The location of the event or organization.
358 "latitude": 3.14, # Latitude.
359 "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
360 "type": "A String", # The schema.org URL that best describes the referenced target and matches the type of moment.
361 "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
362 "contentSize": "A String", # File size in (mega/kilo) bytes.
363 "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
364 "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
365 "description": "A String", # The string that describes the content of the result.
366 "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
367 "kind": "plus#itemScope", # Identifies this resource as an itemScope.
368 "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
369 "postalCode": "A String", # Postal code.
370 "attendeeCount": 42, # Number of attendees.
371 "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
372 "addressRegion": "A String", # Address region.
373 "height": "A String", # The height of the media object.
374 "geo": # Object with schema name: ItemScope # Geo coordinates.
375 "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
376 "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
377 "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
378 "about": # Object with schema name: ItemScope # The subject matter of the content.
379 "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
380 "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
381 "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
382 # Object with schema name: ItemScope
383 ],
384 "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
385 "gender": "A String", # Gender of the person.
386 "longitude": 3.14, # Longitude.
387 "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
388 "caption": "A String", # The caption for this object.
389 "ratingValue": "A String", # Rating value.
390 "reviewRating": # Object with schema name: ItemScope # Review rating.
391 "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
392 },
393 "type": "A String", # The Google schema for the type of moment to write. For example, http://schemas.google.com/AddActivity.
394 "id": "A String", # The moment ID.
395 }</pre>
396</div>
397
398<div class="method">
399 <code class="details" id="list">list(userId, collection, pageToken=None, maxResults=None, targetUrl=None, type=None)</code>
400 <pre>List all of the moments for a particular user.
401
402Args:
403 userId: string, The ID of the user to get moments for. The special value "me" can be used to indicate the authenticated user. (required)
404 collection: string, The collection of moments to list. (required)
405 Allowed values
406 vault - All moments created by the requesting application for the authenticated user.
407 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.
408 maxResults: integer, The maximum number of moments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
409 targetUrl: string, Only moments containing this targetUrl will be returned.
410 type: string, Only moments of this type will be returned.
411
412Returns:
413 An object of the form:
414
415 {
416 "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.
417 "kind": "plus#momentsFeed", # Identifies this resource as a collection of moments. Value: "plus#momentsFeed".
418 "title": "A String", # The title of this collection of moments.
419 "items": [ # The moments in this page of results.
420 {
421 "startDate": "A String", # Time stamp of when the action occurred in RFC3339 format.
422 "kind": "plus#moment", # Identifies this resource as a moment.
423 "target": { # The object on which the action was performed.
424 "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
425 "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
426 "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
427 "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
428 "address": # Object with schema name: ItemScope # Postal address.
429 "birthDate": "A String", # Date of birth.
430 "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
431 "addressLocality": "A String", # Address locality.
432 "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
433 "additionalName": [ # An additional name for a Person, can be used for a middle name.
434 "A String",
435 ],
436 "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
437 "contributor": [ # A list of contributors to this result.
438 # Object with schema name: ItemScope
439 ],
440 "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
441 "id": "A String", # An identifier for the target. Your app can choose how to identify targets. The target.id is required if you are writing an activity that does not have a corresponding web page or target.url property.
442 "postOfficeBoxNumber": "A String", # Post office box number.
443 "attendees": [ # A person attending the event.
444 # Object with schema name: ItemScope
445 ],
446 "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
447 # Object with schema name: ItemScope
448 ],
449 "associated_media": [ # The encoding.
450 # Object with schema name: ItemScope
451 ],
452 "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
453 "addressCountry": "A String", # Address country.
454 "width": "A String", # The width of the media object.
455 "streetAddress": "A String", # Street address.
456 "location": # Object with schema name: ItemScope # The location of the event or organization.
457 "latitude": 3.14, # Latitude.
458 "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
459 "type": "A String", # The schema.org URL that best describes the referenced target and matches the type of moment.
460 "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
461 "contentSize": "A String", # File size in (mega/kilo) bytes.
462 "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
463 "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
464 "description": "A String", # The string that describes the content of the result.
465 "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
466 "kind": "plus#itemScope", # Identifies this resource as an itemScope.
467 "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
468 "postalCode": "A String", # Postal code.
469 "attendeeCount": 42, # Number of attendees.
470 "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
471 "addressRegion": "A String", # Address region.
472 "height": "A String", # The height of the media object.
473 "geo": # Object with schema name: ItemScope # Geo coordinates.
474 "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
475 "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
476 "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
477 "about": # Object with schema name: ItemScope # The subject matter of the content.
478 "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
479 "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
480 "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
481 # Object with schema name: ItemScope
482 ],
483 "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
484 "gender": "A String", # Gender of the person.
485 "longitude": 3.14, # Longitude.
486 "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
487 "caption": "A String", # The caption for this object.
488 "ratingValue": "A String", # Rating value.
489 "reviewRating": # Object with schema name: ItemScope # Review rating.
490 "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
491 },
492 "result": { # The object generated by performing the action on the target. For example, a user writes a review of a restaurant, the target is the restaurant and the result is the review.
493 "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
494 "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
495 "text": "A String", # The text that is the result of the app activity. For example, if a user leaves a review of a restaurant, this might be the text of the review.
496 "image": "A String", # A URL to the image that represents this result. For example, if a user writes a review of a restaurant and attaches a photo of their meal, you might use that photo as the result.image.
497 "address": # Object with schema name: ItemScope # Postal address.
498 "birthDate": "A String", # Date of birth.
499 "datePublished": "A String", # The initial date that the result was published. For example, a user writes a comment on a blog, which has a result.dateCreated of when they submit it. If the blog users comment moderation, the result.datePublished value would match the date when the owner approved the message.
500 "addressLocality": "A String", # Address locality.
501 "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
502 "additionalName": [ # An additional name for a Person, can be used for a middle name.
503 "A String",
504 ],
505 "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
506 "contributor": [ # A list of contributors to this result.
507 # Object with schema name: ItemScope
508 ],
509 "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
510 "id": "A String", # An identifier for the target. Your app can choose how to identify targets. The target.id is required if you are writing an activity that does not have a corresponding web page or target.url property.
511 "postOfficeBoxNumber": "A String", # Post office box number.
512 "attendees": [ # A person attending the event.
513 # Object with schema name: ItemScope
514 ],
515 "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
516 # Object with schema name: ItemScope
517 ],
518 "associated_media": [ # The encoding.
519 # Object with schema name: ItemScope
520 ],
521 "bestRating": "A String", # Best possible rating value that a result might obtain. This property defines the upper bound for the ratingValue. For example, you might have a 5 star rating scale, you would provide 5 as the value for this property.
522 "addressCountry": "A String", # Address country.
523 "width": "A String", # The width of the media object.
524 "streetAddress": "A String", # Street address.
525 "location": # Object with schema name: ItemScope # The location of the event or organization.
526 "latitude": 3.14, # Latitude.
527 "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
528 "type": "A String", # The schema.org URL that best describes the referenced target and matches the type of moment.
529 "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
530 "contentSize": "A String", # File size in (mega/kilo) bytes.
531 "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
532 "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
533 "description": "A String", # The string that describes the content of the result.
534 "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
535 "kind": "plus#itemScope", # Identifies this resource as an itemScope.
536 "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
537 "postalCode": "A String", # Postal code.
538 "attendeeCount": 42, # Number of attendees.
539 "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
540 "addressRegion": "A String", # Address region.
541 "height": "A String", # The height of the media object.
542 "geo": # Object with schema name: ItemScope # Geo coordinates.
543 "embedUrl": "A String", # A URL pointing to a player for a specific video. In general, this is the information in the src element of an embed tag and should not be the same as the content of the loc tag.
544 "tickerSymbol": "A String", # The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we recommend using the controlled vocabulary of Market Identifier Codes (MIC) specified in ISO15022.
545 "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
546 "about": # Object with schema name: ItemScope # The subject matter of the content.
547 "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
548 "name": "A String", # The name of the result. In the example of a restaurant review, this might be the summary the user gave their review such as "Great ambiance, but overpriced."
549 "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
550 # Object with schema name: ItemScope
551 ],
552 "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
553 "gender": "A String", # Gender of the person.
554 "longitude": 3.14, # Longitude.
555 "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
556 "caption": "A String", # The caption for this object.
557 "ratingValue": "A String", # Rating value.
558 "reviewRating": # Object with schema name: ItemScope # Review rating.
559 "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
560 },
561 "type": "A String", # The Google schema for the type of moment to write. For example, http://schemas.google.com/AddActivity.
562 "id": "A String", # The moment ID.
563 },
564 ],
565 "updated": "A String", # The RFC 339 timestamp for when this collection of moments was last updated.
566 "nextLink": "A String", # Link to the next page of moments.
567 "etag": "A String", # ETag of this response for caching purposes.
568 "selfLink": "A String", # Link to this page of moments.
569 }</pre>
570</div>
571
572<div class="method">
573 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
574 <pre>Retrieves the next page of results.
575
576Args:
577 previous_request: The request for the previous page. (required)
578 previous_response: The response from the request for the previous page. (required)
579
580Returns:
581 A request object that you can call 'execute()' on to request the next
582 page. Returns None if there are no more items in the collection.
583 </pre>
584</div>
585
586<div class="method">
587 <code class="details" id="remove">remove(id)</code>
588 <pre>Delete a moment.
589
590Args:
591 id: string, The ID of the moment to delete. (required)
592</pre>
593</div>
594
595</body></html>