1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="plus_v1.html">Google+ API</a> . <a href="plus_v1.comments.html">comments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(commentId)</a></code></p>
<p class="firstline">Shut down. See https://developers.google.com/+/api-shutdown for more details.</p>
<p class="toc_element">
<code><a href="#list">list(activityId, pageToken=None, maxResults=None, sortOrder=None)</a></code></p>
<p class="firstline">Shut down. See https://developers.google.com/+/api-shutdown for more details.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(commentId)</code>
<pre>Shut down. See https://developers.google.com/+/api-shutdown for more details.
Args:
commentId: string, The ID of the comment to get. (required)
Returns:
An object of the form:
{
"inReplyTo": [ # The activity this comment replied to.
{
"url": "A String", # The URL of the activity.
"id": "A String", # The ID of the activity.
},
],
"kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
"plusoners": { # People who +1'd this comment.
"totalItems": 42, # Total number of people who +1'd this comment.
},
"object": { # The object of this comment.
"content": "A String", # The HTML-formatted content, suitable for display.
"originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
"objectType": "comment", # The object type of this comment. Possible values are:
# - "comment" - A comment in reply to an activity.
},
"updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
"actor": { # The person who posted this comment.
"displayName": "A String", # The name of this actor, suitable for display.
"url": "A String", # A link to the Person resource for this actor.
"image": { # The image representation of this actor.
"url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
},
"clientSpecificActorInfo": { # Actor info specific to particular clients.
"youtubeActorInfo": { # Actor info specific to YouTube clients.
"channelId": "A String", # ID of the YouTube channel owned by the Actor.
},
},
"verification": { # Verification status of actor.
"adHocVerified": "A String", # Verification for one-time or manual processes.
},
"id": "A String", # The ID of the actor.
},
"verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
# - "post" - Publish content to the stream.
"etag": "A String", # ETag of this response for caching purposes.
"published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
"id": "A String", # The ID of this comment.
"selfLink": "A String", # Link to this comment resource.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(activityId, pageToken=None, maxResults=None, sortOrder=None)</code>
<pre>Shut down. See https://developers.google.com/+/api-shutdown for more details.
Args:
activityId: string, The ID of the activity to get comments for. (required)
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.
maxResults: integer, The maximum number of comments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
sortOrder: string, The order in which to sort the list of comments.
Allowed values
ascending - Sort oldest comments first.
descending - Sort newest comments first.
Returns:
An object of the form:
{
"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.
"kind": "plus#commentFeed", # Identifies this resource as a collection of comments. Value: "plus#commentFeed".
"title": "A String", # The title of this collection of comments.
"items": [ # The comments in this page of results.
{
"inReplyTo": [ # The activity this comment replied to.
{
"url": "A String", # The URL of the activity.
"id": "A String", # The ID of the activity.
},
],
"kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
"plusoners": { # People who +1'd this comment.
"totalItems": 42, # Total number of people who +1'd this comment.
},
"object": { # The object of this comment.
"content": "A String", # The HTML-formatted content, suitable for display.
"originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
"objectType": "comment", # The object type of this comment. Possible values are:
# - "comment" - A comment in reply to an activity.
},
"updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
"actor": { # The person who posted this comment.
"displayName": "A String", # The name of this actor, suitable for display.
"url": "A String", # A link to the Person resource for this actor.
"image": { # The image representation of this actor.
"url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
},
"clientSpecificActorInfo": { # Actor info specific to particular clients.
"youtubeActorInfo": { # Actor info specific to YouTube clients.
"channelId": "A String", # ID of the YouTube channel owned by the Actor.
},
},
"verification": { # Verification status of actor.
"adHocVerified": "A String", # Verification for one-time or manual processes.
},
"id": "A String", # The ID of the actor.
},
"verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
# - "post" - Publish content to the stream.
"etag": "A String", # ETag of this response for caching purposes.
"published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
"id": "A String", # The ID of this comment.
"selfLink": "A String", # Link to this comment resource.
},
],
"updated": "A String", # The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp.
"nextLink": "A String", # Link to the next page of activities.
"etag": "A String", # ETag of this response for caching purposes.
"id": "A String", # The ID of this collection of comments.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|