Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / db5a0ed106aff656a031a99ad64780ffd88c8425 / . / docs / dyn / plus_v1.moments.html
blob: 9670004f65dc004fbfedac600581163496079b0f [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>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]79<p class="firstline">Record a moment representing a user's action such as making a purchase or commenting on a blog.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]92 <pre>Record a moment representing a user's action such as making a purchase or commenting on a blog.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]93
94Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]95 userId: string, The ID of the user to record actions for. The only valid values are "me" and the ID of the authenticated user. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]123 "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]141 "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]174 "object": { # The object on which the action was performed. Specifying this is equivalent with specifying "target". Note that responses from the server will use the "target" field instead for backward-compatibility with older clients.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]192 "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]210 "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]243 "result": { # The object generated by performing the action on the object. For example, a user writes a review of a restaurant, the object is the restaurant and the result is the review.
244 "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
245 "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
246 "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.
247 "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.
248 "address": # Object with schema name: ItemScope # Postal address.
249 "birthDate": "A String", # Date of birth.
250 "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.
251 "addressLocality": "A String", # Address locality.
252 "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
253 "additionalName": [ # An additional name for a Person, can be used for a middle name.
254 "A String",
255 ],
256 "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
257 "contributor": [ # A list of contributors to this result.
258 # Object with schema name: ItemScope
259 ],
260 "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
261 "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
262 "postOfficeBoxNumber": "A String", # Post office box number.
263 "attendees": [ # A person attending the event.
264 # Object with schema name: ItemScope
265 ],
266 "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
267 # Object with schema name: ItemScope
268 ],
269 "associated_media": [ # The encoding.
270 # Object with schema name: ItemScope
271 ],
272 "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.
273 "addressCountry": "A String", # Address country.
274 "width": "A String", # The width of the media object.
275 "streetAddress": "A String", # Street address.
276 "location": # Object with schema name: ItemScope # The location of the event or organization.
277 "latitude": 3.14, # Latitude.
278 "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
279 "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
280 "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
281 "contentSize": "A String", # File size in (mega/kilo) bytes.
282 "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
283 "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
284 "description": "A String", # The string that describes the content of the result.
285 "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
286 "kind": "plus#itemScope", # Identifies this resource as an itemScope.
287 "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
288 "postalCode": "A String", # Postal code.
289 "attendeeCount": 42, # Number of attendees.
290 "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
291 "addressRegion": "A String", # Address region.
292 "height": "A String", # The height of the media object.
293 "geo": # Object with schema name: ItemScope # Geo coordinates.
294 "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.
295 "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.
296 "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
297 "about": # Object with schema name: ItemScope # The subject matter of the content.
298 "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
299 "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."
300 "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
301 # Object with schema name: ItemScope
302 ],
303 "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
304 "gender": "A String", # Gender of the person.
305 "longitude": 3.14, # Longitude.
306 "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
307 "caption": "A String", # The caption for this object.
308 "ratingValue": "A String", # Rating value.
309 "reviewRating": # Object with schema name: ItemScope # Review rating.
310 "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
311 },
312 "type": "A String", # The schema.org type for the type of moment to write. For example, http://schema.org/AddAction. Note that responses from the server will use the Google schema type instead for backward-compatibility with older clients. For example, http://schemas.google.com/AddActivity.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]313 "id": "A String", # The moment ID.
314 }
315
316 debug: boolean, Return the moment as written. Should be used only for debugging.
317
318Returns:
319 An object of the form:
320
321 {
322 "startDate": "A String", # Time stamp of when the action occurred in RFC3339 format.
323 "kind": "plus#moment", # Identifies this resource as a moment.
324 "target": { # The object on which the action was performed.
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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]342 "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]360 "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]393 "object": { # The object on which the action was performed. Specifying this is equivalent with specifying "target". Note that responses from the server will use the "target" field instead for backward-compatibility with older clients.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]394 "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
395 "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
396 "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.
397 "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.
398 "address": # Object with schema name: ItemScope # Postal address.
399 "birthDate": "A String", # Date of birth.
400 "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.
401 "addressLocality": "A String", # Address locality.
402 "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
403 "additionalName": [ # An additional name for a Person, can be used for a middle name.
404 "A String",
405 ],
406 "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
407 "contributor": [ # A list of contributors to this result.
408 # Object with schema name: ItemScope
409 ],
410 "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]411 "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]412 "postOfficeBoxNumber": "A String", # Post office box number.
413 "attendees": [ # A person attending the event.
414 # Object with schema name: ItemScope
415 ],
416 "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
417 # Object with schema name: ItemScope
418 ],
419 "associated_media": [ # The encoding.
420 # Object with schema name: ItemScope
421 ],
422 "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.
423 "addressCountry": "A String", # Address country.
424 "width": "A String", # The width of the media object.
425 "streetAddress": "A String", # Street address.
426 "location": # Object with schema name: ItemScope # The location of the event or organization.
427 "latitude": 3.14, # Latitude.
428 "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]429 "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]430 "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
431 "contentSize": "A String", # File size in (mega/kilo) bytes.
432 "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
433 "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
434 "description": "A String", # The string that describes the content of the result.
435 "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
436 "kind": "plus#itemScope", # Identifies this resource as an itemScope.
437 "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
438 "postalCode": "A String", # Postal code.
439 "attendeeCount": 42, # Number of attendees.
440 "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
441 "addressRegion": "A String", # Address region.
442 "height": "A String", # The height of the media object.
443 "geo": # Object with schema name: ItemScope # Geo coordinates.
444 "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.
445 "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.
446 "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
447 "about": # Object with schema name: ItemScope # The subject matter of the content.
448 "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
449 "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."
450 "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
451 # Object with schema name: ItemScope
452 ],
453 "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
454 "gender": "A String", # Gender of the person.
455 "longitude": 3.14, # Longitude.
456 "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
457 "caption": "A String", # The caption for this object.
458 "ratingValue": "A String", # Rating value.
459 "reviewRating": # Object with schema name: ItemScope # Review rating.
460 "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
461 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]462 "result": { # The object generated by performing the action on the object. For example, a user writes a review of a restaurant, the object is the restaurant and the result is the review.
463 "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
464 "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
465 "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.
466 "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.
467 "address": # Object with schema name: ItemScope # Postal address.
468 "birthDate": "A String", # Date of birth.
469 "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.
470 "addressLocality": "A String", # Address locality.
471 "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
472 "additionalName": [ # An additional name for a Person, can be used for a middle name.
473 "A String",
474 ],
475 "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
476 "contributor": [ # A list of contributors to this result.
477 # Object with schema name: ItemScope
478 ],
479 "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
480 "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
481 "postOfficeBoxNumber": "A String", # Post office box number.
482 "attendees": [ # A person attending the event.
483 # Object with schema name: ItemScope
484 ],
485 "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
486 # Object with schema name: ItemScope
487 ],
488 "associated_media": [ # The encoding.
489 # Object with schema name: ItemScope
490 ],
491 "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.
492 "addressCountry": "A String", # Address country.
493 "width": "A String", # The width of the media object.
494 "streetAddress": "A String", # Street address.
495 "location": # Object with schema name: ItemScope # The location of the event or organization.
496 "latitude": 3.14, # Latitude.
497 "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
498 "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
499 "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
500 "contentSize": "A String", # File size in (mega/kilo) bytes.
501 "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
502 "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
503 "description": "A String", # The string that describes the content of the result.
504 "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
505 "kind": "plus#itemScope", # Identifies this resource as an itemScope.
506 "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
507 "postalCode": "A String", # Postal code.
508 "attendeeCount": 42, # Number of attendees.
509 "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
510 "addressRegion": "A String", # Address region.
511 "height": "A String", # The height of the media object.
512 "geo": # Object with schema name: ItemScope # Geo coordinates.
513 "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.
514 "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.
515 "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
516 "about": # Object with schema name: ItemScope # The subject matter of the content.
517 "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
518 "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."
519 "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
520 # Object with schema name: ItemScope
521 ],
522 "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
523 "gender": "A String", # Gender of the person.
524 "longitude": 3.14, # Longitude.
525 "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
526 "caption": "A String", # The caption for this object.
527 "ratingValue": "A String", # Rating value.
528 "reviewRating": # Object with schema name: ItemScope # Review rating.
529 "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
530 },
531 "type": "A String", # The schema.org type for the type of moment to write. For example, http://schema.org/AddAction. Note that responses from the server will use the Google schema type instead for backward-compatibility with older clients. For example, http://schemas.google.com/AddActivity.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]532 "id": "A String", # The moment ID.
533 }</pre>
534</div>
535
536<div class="method">
537 <code class="details" id="list">list(userId, collection, pageToken=None, maxResults=None, targetUrl=None, type=None)</code>
538 <pre>List all of the moments for a particular user.
539
540Args:
541 userId: string, The ID of the user to get moments for. The special value "me" can be used to indicate the authenticated user. (required)
542 collection: string, The collection of moments to list. (required)
543 Allowed values
544 vault - All moments created by the requesting application for the authenticated user.
545 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.
546 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.
547 targetUrl: string, Only moments containing this targetUrl will be returned.
548 type: string, Only moments of this type will be returned.
549
550Returns:
551 An object of the form:
552
553 {
554 "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.
555 "kind": "plus#momentsFeed", # Identifies this resource as a collection of moments. Value: "plus#momentsFeed".
556 "title": "A String", # The title of this collection of moments.
557 "items": [ # The moments in this page of results.
558 {
559 "startDate": "A String", # Time stamp of when the action occurred in RFC3339 format.
560 "kind": "plus#moment", # Identifies this resource as a moment.
561 "target": { # The object on which the action was performed.
562 "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
563 "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
564 "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.
565 "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.
566 "address": # Object with schema name: ItemScope # Postal address.
567 "birthDate": "A String", # Date of birth.
568 "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.
569 "addressLocality": "A String", # Address locality.
570 "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
571 "additionalName": [ # An additional name for a Person, can be used for a middle name.
572 "A String",
573 ],
574 "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
575 "contributor": [ # A list of contributors to this result.
576 # Object with schema name: ItemScope
577 ],
578 "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]579 "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]580 "postOfficeBoxNumber": "A String", # Post office box number.
581 "attendees": [ # A person attending the event.
582 # Object with schema name: ItemScope
583 ],
584 "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
585 # Object with schema name: ItemScope
586 ],
587 "associated_media": [ # The encoding.
588 # Object with schema name: ItemScope
589 ],
590 "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.
591 "addressCountry": "A String", # Address country.
592 "width": "A String", # The width of the media object.
593 "streetAddress": "A String", # Street address.
594 "location": # Object with schema name: ItemScope # The location of the event or organization.
595 "latitude": 3.14, # Latitude.
596 "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]597 "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]598 "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
599 "contentSize": "A String", # File size in (mega/kilo) bytes.
600 "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
601 "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
602 "description": "A String", # The string that describes the content of the result.
603 "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
604 "kind": "plus#itemScope", # Identifies this resource as an itemScope.
605 "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
606 "postalCode": "A String", # Postal code.
607 "attendeeCount": 42, # Number of attendees.
608 "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
609 "addressRegion": "A String", # Address region.
610 "height": "A String", # The height of the media object.
611 "geo": # Object with schema name: ItemScope # Geo coordinates.
612 "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.
613 "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.
614 "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
615 "about": # Object with schema name: ItemScope # The subject matter of the content.
616 "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
617 "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."
618 "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
619 # Object with schema name: ItemScope
620 ],
621 "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
622 "gender": "A String", # Gender of the person.
623 "longitude": 3.14, # Longitude.
624 "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
625 "caption": "A String", # The caption for this object.
626 "ratingValue": "A String", # Rating value.
627 "reviewRating": # Object with schema name: ItemScope # Review rating.
628 "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
629 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]630 "object": { # The object on which the action was performed. Specifying this is equivalent with specifying "target". Note that responses from the server will use the "target" field instead for backward-compatibility with older clients.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]631 "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
632 "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
633 "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.
634 "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.
635 "address": # Object with schema name: ItemScope # Postal address.
636 "birthDate": "A String", # Date of birth.
637 "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.
638 "addressLocality": "A String", # Address locality.
639 "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
640 "additionalName": [ # An additional name for a Person, can be used for a middle name.
641 "A String",
642 ],
643 "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
644 "contributor": [ # A list of contributors to this result.
645 # Object with schema name: ItemScope
646 ],
647 "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]648 "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]649 "postOfficeBoxNumber": "A String", # Post office box number.
650 "attendees": [ # A person attending the event.
651 # Object with schema name: ItemScope
652 ],
653 "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
654 # Object with schema name: ItemScope
655 ],
656 "associated_media": [ # The encoding.
657 # Object with schema name: ItemScope
658 ],
659 "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.
660 "addressCountry": "A String", # Address country.
661 "width": "A String", # The width of the media object.
662 "streetAddress": "A String", # Street address.
663 "location": # Object with schema name: ItemScope # The location of the event or organization.
664 "latitude": 3.14, # Latitude.
665 "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]666 "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]667 "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
668 "contentSize": "A String", # File size in (mega/kilo) bytes.
669 "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
670 "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
671 "description": "A String", # The string that describes the content of the result.
672 "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
673 "kind": "plus#itemScope", # Identifies this resource as an itemScope.
674 "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
675 "postalCode": "A String", # Postal code.
676 "attendeeCount": 42, # Number of attendees.
677 "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
678 "addressRegion": "A String", # Address region.
679 "height": "A String", # The height of the media object.
680 "geo": # Object with schema name: ItemScope # Geo coordinates.
681 "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.
682 "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.
683 "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
684 "about": # Object with schema name: ItemScope # The subject matter of the content.
685 "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
686 "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."
687 "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
688 # Object with schema name: ItemScope
689 ],
690 "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
691 "gender": "A String", # Gender of the person.
692 "longitude": 3.14, # Longitude.
693 "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
694 "caption": "A String", # The caption for this object.
695 "ratingValue": "A String", # Rating value.
696 "reviewRating": # Object with schema name: ItemScope # Review rating.
697 "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
698 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]699 "result": { # The object generated by performing the action on the object. For example, a user writes a review of a restaurant, the object is the restaurant and the result is the review.
700 "startDate": "A String", # The start date and time of the event (in ISO 8601 date format).
701 "endDate": "A String", # The end date and time of the event (in ISO 8601 date format).
702 "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.
703 "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.
704 "address": # Object with schema name: ItemScope # Postal address.
705 "birthDate": "A String", # Date of birth.
706 "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.
707 "addressLocality": "A String", # Address locality.
708 "duration": "A String", # The duration of the item (movie, audio recording, event, etc.) in ISO 8601 date format.
709 "additionalName": [ # An additional name for a Person, can be used for a middle name.
710 "A String",
711 ],
712 "worstRating": "A String", # Worst possible rating value that a result might obtain. This property defines the lower bound for the ratingValue.
713 "contributor": [ # A list of contributors to this result.
714 # Object with schema name: ItemScope
715 ],
716 "thumbnailUrl": "A String", # A URL to a thumbnail image that represents this result.
717 "id": "A String", # An identifier for the object. Your app can choose how to identify objects. The object.id is required if you are writing an action that does not have a corresponding web page or object.url property.
718 "postOfficeBoxNumber": "A String", # Post office box number.
719 "attendees": [ # A person attending the event.
720 # Object with schema name: ItemScope
721 ],
722 "author": [ # The person or persons who created this result. In the example of restaurant reviews, this might be the reviewer's name.
723 # Object with schema name: ItemScope
724 ],
725 "associated_media": [ # The encoding.
726 # Object with schema name: ItemScope
727 ],
728 "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.
729 "addressCountry": "A String", # Address country.
730 "width": "A String", # The width of the media object.
731 "streetAddress": "A String", # Street address.
732 "location": # Object with schema name: ItemScope # The location of the event or organization.
733 "latitude": 3.14, # Latitude.
734 "byArtist": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the artist that performed this recording.
735 "type": "A String", # The schema.org URL that best describes the referenced object and matches the type of moment.
736 "dateModified": "A String", # The date the result was last modified such as the date that a review was last edited.
737 "contentSize": "A String", # File size in (mega/kilo) bytes.
738 "contentUrl": "A String", # Actual bytes of the media object, for example the image file or video file.
739 "partOfTVSeries": # Object with schema name: ItemScope # Property of http://schema.org/TVEpisode indicating which series the episode belongs to.
740 "description": "A String", # The string that describes the content of the result.
741 "familyName": "A String", # Family name. This property can be used with givenName instead of the name property.
742 "kind": "plus#itemScope", # Identifies this resource as an itemScope.
743 "dateCreated": "A String", # The date the result was created such as the date that a review was first created.
744 "postalCode": "A String", # Postal code.
745 "attendeeCount": 42, # Number of attendees.
746 "inAlbum": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, which album a song is in.
747 "addressRegion": "A String", # Address region.
748 "height": "A String", # The height of the media object.
749 "geo": # Object with schema name: ItemScope # Geo coordinates.
750 "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.
751 "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.
752 "playerType": "A String", # Player type that is required. For example: Flash or Silverlight.
753 "about": # Object with schema name: ItemScope # The subject matter of the content.
754 "givenName": "A String", # Given name. This property can be used with familyName instead of the name property.
755 "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."
756 "performers": [ # The main performer or performers of the event-for example, a presenter, musician, or actor.
757 # Object with schema name: ItemScope
758 ],
759 "url": "A String", # The URL that points to the result object. For example, a permalink directly to a restaurant reviewer's comment.
760 "gender": "A String", # Gender of the person.
761 "longitude": 3.14, # Longitude.
762 "thumbnail": # Object with schema name: ItemScope # Thumbnail image for an image or video.
763 "caption": "A String", # The caption for this object.
764 "ratingValue": "A String", # Rating value.
765 "reviewRating": # Object with schema name: ItemScope # Review rating.
766 "audio": # Object with schema name: ItemScope # From http://schema.org/MusicRecording, the audio file.
767 },
768 "type": "A String", # The schema.org type for the type of moment to write. For example, http://schema.org/AddAction. Note that responses from the server will use the Google schema type instead for backward-compatibility with older clients. For example, http://schemas.google.com/AddActivity.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]769 "id": "A String", # The moment ID.
770 },
771 ],
772 "updated": "A String", # The RFC 339 timestamp for when this collection of moments was last updated.
773 "nextLink": "A String", # Link to the next page of moments.
774 "etag": "A String", # ETag of this response for caching purposes.
775 "selfLink": "A String", # Link to this page of moments.
776 }</pre>
777</div>
778
779<div class="method">
780 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
781 <pre>Retrieves the next page of results.
782
783Args:
784 previous_request: The request for the previous page. (required)
785 previous_response: The response from the request for the previous page. (required)
786
787Returns:
788 A request object that you can call 'execute()' on to request the next
789 page. Returns None if there are no more items in the collection.
790 </pre>
791</div>
792
793<div class="method">
794 <code class="details" id="remove">remove(id)</code>
795 <pre>Delete a moment.
796
797Args:
798 id: string, The ID of the moment to delete. (required)
799</pre>
800</div>
801
802</body></html>