John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 | |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 75 | <h1><a href="blogger_v3.html">Blogger API v3</a> . <a href="blogger_v3.postUserInfos.html">postUserInfos</a></h1> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#get">get(userId, blogId, postId, maxComments=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Gets one post and user info pair, by post_id and user_id.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <p class="toc_element"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 84 | <code><a href="#list">list(userId, blogId, endDate=None, fetchBodies=None, labels=None, maxResults=None, orderBy=None, pageToken=None, startDate=None, status=None, view=None, x__xgafv=None)</a></code></p> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 85 | <p class="firstline">Lists post and user info pairs.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code class="details" id="get">get(userId, blogId, postId, maxComments=None, x__xgafv=None)</code> |
| 97 | <pre>Gets one post and user info pair, by post_id and user_id. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 98 | |
| 99 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 100 | userId: string, A parameter (required) |
| 101 | blogId: string, A parameter (required) |
| 102 | postId: string, A parameter (required) |
| 103 | maxComments: integer, A parameter |
| 104 | x__xgafv: string, V1 error format. |
| 105 | Allowed values |
| 106 | 1 - v1 error format |
| 107 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 108 | |
| 109 | Returns: |
| 110 | An object of the form: |
| 111 | |
| 112 | { |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 113 | "kind": "A String", # The kind of this entity. Always blogger#postUserInfo. |
| 114 | "post": { # The Post resource. |
| 115 | "author": { # The author of this Post. |
| 116 | "displayName": "A String", # The display name. |
| 117 | "id": "A String", # The identifier of the creator. |
| 118 | "image": { # The creator's avatar. |
| 119 | "url": "A String", # The creator's avatar URL. |
| 120 | }, |
| 121 | "url": "A String", # The URL of the creator's Profile page. |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 122 | }, |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 123 | "blog": { # Data about the blog containing this Post. |
| 124 | "id": "A String", # The identifier of the Blog that contains this Post. |
| 125 | }, |
| 126 | "content": "A String", # The content of the Post. May contain HTML markup. |
| 127 | "customMetaData": "A String", # The JSON meta-data for the Post. |
| 128 | "etag": "A String", # Etag of the resource. |
| 129 | "id": "A String", # The identifier of this Post. |
| 130 | "images": [ # Display image for the Post. |
| 131 | { |
| 132 | "url": "A String", |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 133 | }, |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 134 | ], |
| 135 | "kind": "A String", # The kind of this entity. Always blogger#post. |
| 136 | "labels": [ # The list of labels this Post was tagged with. |
| 137 | "A String", |
| 138 | ], |
| 139 | "location": { # The location for geotagged posts. |
| 140 | "lat": 3.14, # Location's latitude. |
| 141 | "lng": 3.14, # Location's longitude. |
| 142 | "name": "A String", # Location name. |
| 143 | "span": "A String", # Location's viewport span. Can be used when rendering a map preview. |
| 144 | }, |
| 145 | "published": "A String", # RFC 3339 date-time when this Post was published. |
| 146 | "readerComments": "A String", # Comment control and display setting for readers of this post. |
| 147 | "replies": { # The container of comments on this Post. |
| 148 | "items": [ # The List of Comments for this Post. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 149 | { |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 150 | "author": { # The author of this Comment. |
| 151 | "displayName": "A String", # The display name. |
| 152 | "id": "A String", # The identifier of the creator. |
| 153 | "image": { # The creator's avatar. |
| 154 | "url": "A String", # The creator's avatar URL. |
| 155 | }, |
| 156 | "url": "A String", # The URL of the creator's Profile page. |
| 157 | }, |
| 158 | "blog": { # Data about the blog containing this comment. |
| 159 | "id": "A String", # The identifier of the blog containing this comment. |
| 160 | }, |
| 161 | "content": "A String", # The actual content of the comment. May include HTML markup. |
| 162 | "id": "A String", # The identifier for this resource. |
| 163 | "inReplyTo": { # Data about the comment this is in reply to. |
| 164 | "id": "A String", # The identified of the parent of this comment. |
| 165 | }, |
| 166 | "kind": "A String", # The kind of this entry. Always blogger#comment. |
| 167 | "post": { # Data about the post containing this comment. |
| 168 | "id": "A String", # The identifier of the post containing this comment. |
| 169 | }, |
| 170 | "published": "A String", # RFC 3339 date-time when this comment was published. |
| 171 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 172 | "status": "A String", # The status of the comment (only populated for admin users). |
| 173 | "updated": "A String", # RFC 3339 date-time when this comment was last updated. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 174 | }, |
| 175 | ], |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 176 | "selfLink": "A String", # The URL of the comments on this post. |
| 177 | "totalItems": "A String", # The count of comments on this post. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 178 | }, |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 179 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 180 | "status": "A String", # Status of the post. Only set for admin-level requests. |
| 181 | "title": "A String", # The title of the Post. |
| 182 | "titleLink": "A String", # The title link URL, similar to atom's related link. |
| 183 | "updated": "A String", # RFC 3339 date-time when this Post was last updated. |
| 184 | "url": "A String", # The URL where this Post is displayed. |
| 185 | }, |
| 186 | "post_user_info": { # Information about a User for the Post. |
| 187 | "blogId": "A String", # ID of the Blog that the post resource belongs to. |
| 188 | "hasEditAccess": True or False, # True if the user has Author level access to the post. |
| 189 | "kind": "A String", # The kind of this entity. Always blogger#postPerUserInfo. |
| 190 | "postId": "A String", # ID of the Post resource. |
| 191 | "userId": "A String", # ID of the User. |
| 192 | }, |
| 193 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 194 | </div> |
| 195 | |
| 196 | <div class="method"> |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 197 | <code class="details" id="list">list(userId, blogId, endDate=None, fetchBodies=None, labels=None, maxResults=None, orderBy=None, pageToken=None, startDate=None, status=None, view=None, x__xgafv=None)</code> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 198 | <pre>Lists post and user info pairs. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 199 | |
| 200 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 201 | userId: string, A parameter (required) |
| 202 | blogId: string, A parameter (required) |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 203 | endDate: string, A parameter |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 204 | fetchBodies: boolean, A parameter |
| 205 | labels: string, A parameter |
| 206 | maxResults: integer, A parameter |
| 207 | orderBy: string, A parameter |
| 208 | Allowed values |
| 209 | ORDER_BY_UNSPECIFIED - |
| 210 | PUBLISHED - |
| 211 | UPDATED - |
| 212 | pageToken: string, A parameter |
| 213 | startDate: string, A parameter |
| 214 | status: string, A parameter (repeated) |
| 215 | Allowed values |
| 216 | LIVE - |
| 217 | DRAFT - |
| 218 | SCHEDULED - |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 219 | view: string, A parameter |
| 220 | Allowed values |
| 221 | VIEW_TYPE_UNSPECIFIED - |
| 222 | READER - |
| 223 | AUTHOR - |
| 224 | ADMIN - |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 225 | x__xgafv: string, V1 error format. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 226 | Allowed values |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 227 | 1 - v1 error format |
| 228 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 229 | |
| 230 | Returns: |
| 231 | An object of the form: |
| 232 | |
| 233 | { |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 234 | "items": [ # The list of Posts with User information for the post, for this Blog. |
| 235 | { |
| 236 | "kind": "A String", # The kind of this entity. Always blogger#postUserInfo. |
| 237 | "post": { # The Post resource. |
| 238 | "author": { # The author of this Post. |
| 239 | "displayName": "A String", # The display name. |
| 240 | "id": "A String", # The identifier of the creator. |
| 241 | "image": { # The creator's avatar. |
| 242 | "url": "A String", # The creator's avatar URL. |
| 243 | }, |
| 244 | "url": "A String", # The URL of the creator's Profile page. |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 245 | }, |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 246 | "blog": { # Data about the blog containing this Post. |
| 247 | "id": "A String", # The identifier of the Blog that contains this Post. |
| 248 | }, |
| 249 | "content": "A String", # The content of the Post. May contain HTML markup. |
| 250 | "customMetaData": "A String", # The JSON meta-data for the Post. |
| 251 | "etag": "A String", # Etag of the resource. |
| 252 | "id": "A String", # The identifier of this Post. |
| 253 | "images": [ # Display image for the Post. |
| 254 | { |
| 255 | "url": "A String", |
Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 256 | }, |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 257 | ], |
| 258 | "kind": "A String", # The kind of this entity. Always blogger#post. |
| 259 | "labels": [ # The list of labels this Post was tagged with. |
| 260 | "A String", |
| 261 | ], |
| 262 | "location": { # The location for geotagged posts. |
| 263 | "lat": 3.14, # Location's latitude. |
| 264 | "lng": 3.14, # Location's longitude. |
| 265 | "name": "A String", # Location name. |
| 266 | "span": "A String", # Location's viewport span. Can be used when rendering a map preview. |
| 267 | }, |
| 268 | "published": "A String", # RFC 3339 date-time when this Post was published. |
| 269 | "readerComments": "A String", # Comment control and display setting for readers of this post. |
| 270 | "replies": { # The container of comments on this Post. |
| 271 | "items": [ # The List of Comments for this Post. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 272 | { |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 273 | "author": { # The author of this Comment. |
| 274 | "displayName": "A String", # The display name. |
| 275 | "id": "A String", # The identifier of the creator. |
| 276 | "image": { # The creator's avatar. |
| 277 | "url": "A String", # The creator's avatar URL. |
| 278 | }, |
| 279 | "url": "A String", # The URL of the creator's Profile page. |
| 280 | }, |
| 281 | "blog": { # Data about the blog containing this comment. |
| 282 | "id": "A String", # The identifier of the blog containing this comment. |
| 283 | }, |
| 284 | "content": "A String", # The actual content of the comment. May include HTML markup. |
| 285 | "id": "A String", # The identifier for this resource. |
| 286 | "inReplyTo": { # Data about the comment this is in reply to. |
| 287 | "id": "A String", # The identified of the parent of this comment. |
| 288 | }, |
| 289 | "kind": "A String", # The kind of this entry. Always blogger#comment. |
| 290 | "post": { # Data about the post containing this comment. |
| 291 | "id": "A String", # The identifier of the post containing this comment. |
| 292 | }, |
| 293 | "published": "A String", # RFC 3339 date-time when this comment was published. |
| 294 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 295 | "status": "A String", # The status of the comment (only populated for admin users). |
| 296 | "updated": "A String", # RFC 3339 date-time when this comment was last updated. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 297 | }, |
| 298 | ], |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 299 | "selfLink": "A String", # The URL of the comments on this post. |
| 300 | "totalItems": "A String", # The count of comments on this post. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 301 | }, |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 302 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 303 | "status": "A String", # Status of the post. Only set for admin-level requests. |
| 304 | "title": "A String", # The title of the Post. |
| 305 | "titleLink": "A String", # The title link URL, similar to atom's related link. |
| 306 | "updated": "A String", # RFC 3339 date-time when this Post was last updated. |
| 307 | "url": "A String", # The URL where this Post is displayed. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 308 | }, |
Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 309 | "post_user_info": { # Information about a User for the Post. |
| 310 | "blogId": "A String", # ID of the Blog that the post resource belongs to. |
| 311 | "hasEditAccess": True or False, # True if the user has Author level access to the post. |
| 312 | "kind": "A String", # The kind of this entity. Always blogger#postPerUserInfo. |
| 313 | "postId": "A String", # ID of the Post resource. |
| 314 | "userId": "A String", # ID of the User. |
| 315 | }, |
| 316 | }, |
| 317 | ], |
| 318 | "kind": "A String", # The kind of this entity. Always blogger#postList. |
| 319 | "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists. |
| 320 | }</pre> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 321 | </div> |
| 322 | |
| 323 | <div class="method"> |
| 324 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 325 | <pre>Retrieves the next page of results. |
| 326 | |
| 327 | Args: |
| 328 | previous_request: The request for the previous page. (required) |
| 329 | previous_response: The response from the request for the previous page. (required) |
| 330 | |
| 331 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 332 | A request object that you can call 'execute()' on to request the next |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 333 | page. Returns None if there are no more items in the collection. |
| 334 | </pre> |
| 335 | </div> |
| 336 | |
| 337 | </body></html> |