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.blogs.html">blogs</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"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 81 | <code><a href="#get">get(blogId, view=None, maxPosts=None, x__xgafv=None)</a></code></p> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 82 | <p class="firstline">Gets a blog by id.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <p class="toc_element"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 84 | <code><a href="#getByUrl">getByUrl(url, 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">Gets a blog by url.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 86 | <p class="toc_element"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 87 | <code><a href="#listByUser">listByUser(userId, fetchUserInfo=None, status=None, view=None, role=None, x__xgafv=None)</a></code></p> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 88 | <p class="firstline">Lists blogs by user.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 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"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 96 | <code class="details" id="get">get(blogId, view=None, maxPosts=None, x__xgafv=None)</code> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 97 | <pre>Gets a blog by 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 | blogId: string, A parameter (required) |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 101 | view: string, A parameter |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 102 | Allowed values |
| 103 | VIEW_TYPE_UNSPECIFIED - |
| 104 | READER - |
| 105 | AUTHOR - |
| 106 | ADMIN - |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 107 | maxPosts: integer, A parameter |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 108 | x__xgafv: string, V1 error format. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 109 | Allowed values |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 110 | 1 - v1 error format |
| 111 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 112 | |
| 113 | Returns: |
| 114 | An object of the form: |
| 115 | |
| 116 | { |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 117 | "url": "A String", # The URL where this blog is published. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 118 | "posts": { # The container of posts in this blog. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 119 | "totalItems": 42, # The count of posts in this blog. |
| 120 | "selfLink": "A String", # The URL of the container for posts in this blog. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 121 | "items": [ # The List of Posts for this Blog. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 122 | { |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 123 | "published": "A String", # RFC 3339 date-time when this Post was published. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 124 | "images": [ # Display image for the Post. |
| 125 | { |
| 126 | "url": "A String", |
| 127 | }, |
| 128 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 129 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 130 | "url": "A String", # The URL where this Post is displayed. |
| 131 | "content": "A String", # The content of the Post. May contain HTML markup. |
| 132 | "replies": { # The container of comments on this Post. |
| 133 | "totalItems": "A String", # The count of comments on this post. |
| 134 | "selfLink": "A String", # The URL of the comments on this post. |
| 135 | "items": [ # The List of Comments for this Post. |
| 136 | { |
| 137 | "content": "A String", # The actual content of the comment. May include HTML markup. |
| 138 | "post": { # Data about the post containing this comment. |
| 139 | "id": "A String", # The identifier of the post containing this comment. |
| 140 | }, |
| 141 | "kind": "A String", # The kind of this entry. Always blogger#comment. |
| 142 | "id": "A String", # The identifier for this resource. |
| 143 | "inReplyTo": { # Data about the comment this is in reply to. |
| 144 | "id": "A String", # The identified of the parent of this comment. |
| 145 | }, |
| 146 | "published": "A String", # RFC 3339 date-time when this comment was published. |
| 147 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 148 | "author": { # The author of this Comment. |
| 149 | "url": "A String", # The URL of the creator's Profile page. |
| 150 | "displayName": "A String", # The display name. |
| 151 | "image": { # The creator's avatar. |
| 152 | "url": "A String", # The creator's avatar URL. |
| 153 | }, |
| 154 | "id": "A String", # The identifier of the creator. |
| 155 | }, |
| 156 | "updated": "A String", # RFC 3339 date-time when this comment was last updated. |
| 157 | "blog": { # Data about the blog containing this comment. |
| 158 | "id": "A String", # The identifier of the blog containing this comment. |
| 159 | }, |
| 160 | "status": "A String", # The status of the comment (only populated for admin users). |
| 161 | }, |
| 162 | ], |
| 163 | }, |
| 164 | "readerComments": "A String", # Comment control and display setting for readers of this post. |
| 165 | "customMetaData": "A String", # The JSON meta-data for the Post. |
| 166 | "labels": [ # The list of labels this Post was tagged with. |
| 167 | "A String", |
| 168 | ], |
| 169 | "titleLink": "A String", # The title link URL, similar to atom's related link. |
| 170 | "etag": "A String", # Etag of the resource. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 171 | "blog": { # Data about the blog containing this Post. |
| 172 | "id": "A String", # The identifier of the Blog that contains this Post. |
| 173 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 174 | "updated": "A String", # RFC 3339 date-time when this Post was last updated. |
| 175 | "status": "A String", # Status of the post. Only set for admin-level requests. |
| 176 | "id": "A String", # The identifier of this Post. |
| 177 | "location": { # The location for geotagged posts. |
| 178 | "name": "A String", # Location name. |
| 179 | "lat": 3.14, # Location's latitude. |
| 180 | "lng": 3.14, # Location's longitude. |
| 181 | "span": "A String", # Location's viewport span. Can be used when rendering a map preview. |
| 182 | }, |
| 183 | "title": "A String", # The title of the Post. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 184 | "kind": "A String", # The kind of this entity. Always blogger#post. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 185 | "author": { # The author of this Post. |
| 186 | "image": { # The creator's avatar. |
| 187 | "url": "A String", # The creator's avatar URL. |
| 188 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 189 | "id": "A String", # The identifier of the creator. |
| 190 | "url": "A String", # The URL of the creator's Profile page. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 191 | "displayName": "A String", # The display name. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 192 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 193 | }, |
| 194 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 195 | }, |
| 196 | "pages": { # The container of pages in this blog. |
| 197 | "totalItems": 42, # The count of pages in this blog. |
| 198 | "selfLink": "A String", # The URL of the container for pages in this blog. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 199 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 200 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 201 | "kind": "A String", # The kind of this entry. Always blogger#blog. |
| 202 | "status": "A String", # The status of the blog. |
| 203 | "customMetaData": "A String", # The JSON custom meta-data for the Blog. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 204 | "published": "A String", # RFC 3339 date-time when this blog was published. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 205 | "description": "A String", # The description of this blog. This is displayed underneath the title. |
| 206 | "updated": "A String", # RFC 3339 date-time when this blog was last updated. |
| 207 | "locale": { # The locale this Blog is set to. |
| 208 | "variant": "A String", # The language variant this blog is authored in. |
| 209 | "country": "A String", # The country this blog's locale is set to. |
| 210 | "language": "A String", # The language this blog is authored in. |
| 211 | }, |
| 212 | "id": "A String", # The identifier for this resource. |
| 213 | "name": "A String", # The name of this blog. This is displayed as the title. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 214 | }</pre> |
| 215 | </div> |
| 216 | |
| 217 | <div class="method"> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 218 | <code class="details" id="getByUrl">getByUrl(url, view=None, x__xgafv=None)</code> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 219 | <pre>Gets a blog by url. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 220 | |
| 221 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 222 | url: string, A parameter (required) |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 223 | view: string, A parameter |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 224 | Allowed values |
| 225 | VIEW_TYPE_UNSPECIFIED - |
| 226 | READER - |
| 227 | AUTHOR - |
| 228 | ADMIN - |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 229 | x__xgafv: string, V1 error format. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 230 | Allowed values |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 231 | 1 - v1 error format |
| 232 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 233 | |
| 234 | Returns: |
| 235 | An object of the form: |
| 236 | |
| 237 | { |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 238 | "url": "A String", # The URL where this blog is published. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 239 | "posts": { # The container of posts in this blog. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 240 | "totalItems": 42, # The count of posts in this blog. |
| 241 | "selfLink": "A String", # The URL of the container for posts in this blog. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 242 | "items": [ # The List of Posts for this Blog. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 243 | { |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 244 | "published": "A String", # RFC 3339 date-time when this Post was published. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 245 | "images": [ # Display image for the Post. |
| 246 | { |
| 247 | "url": "A String", |
| 248 | }, |
| 249 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 250 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 251 | "url": "A String", # The URL where this Post is displayed. |
| 252 | "content": "A String", # The content of the Post. May contain HTML markup. |
| 253 | "replies": { # The container of comments on this Post. |
| 254 | "totalItems": "A String", # The count of comments on this post. |
| 255 | "selfLink": "A String", # The URL of the comments on this post. |
| 256 | "items": [ # The List of Comments for this Post. |
| 257 | { |
| 258 | "content": "A String", # The actual content of the comment. May include HTML markup. |
| 259 | "post": { # Data about the post containing this comment. |
| 260 | "id": "A String", # The identifier of the post containing this comment. |
| 261 | }, |
| 262 | "kind": "A String", # The kind of this entry. Always blogger#comment. |
| 263 | "id": "A String", # The identifier for this resource. |
| 264 | "inReplyTo": { # Data about the comment this is in reply to. |
| 265 | "id": "A String", # The identified of the parent of this comment. |
| 266 | }, |
| 267 | "published": "A String", # RFC 3339 date-time when this comment was published. |
| 268 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 269 | "author": { # The author of this Comment. |
| 270 | "url": "A String", # The URL of the creator's Profile page. |
| 271 | "displayName": "A String", # The display name. |
| 272 | "image": { # The creator's avatar. |
| 273 | "url": "A String", # The creator's avatar URL. |
| 274 | }, |
| 275 | "id": "A String", # The identifier of the creator. |
| 276 | }, |
| 277 | "updated": "A String", # RFC 3339 date-time when this comment was last updated. |
| 278 | "blog": { # Data about the blog containing this comment. |
| 279 | "id": "A String", # The identifier of the blog containing this comment. |
| 280 | }, |
| 281 | "status": "A String", # The status of the comment (only populated for admin users). |
| 282 | }, |
| 283 | ], |
| 284 | }, |
| 285 | "readerComments": "A String", # Comment control and display setting for readers of this post. |
| 286 | "customMetaData": "A String", # The JSON meta-data for the Post. |
| 287 | "labels": [ # The list of labels this Post was tagged with. |
| 288 | "A String", |
| 289 | ], |
| 290 | "titleLink": "A String", # The title link URL, similar to atom's related link. |
| 291 | "etag": "A String", # Etag of the resource. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 292 | "blog": { # Data about the blog containing this Post. |
| 293 | "id": "A String", # The identifier of the Blog that contains this Post. |
| 294 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 295 | "updated": "A String", # RFC 3339 date-time when this Post was last updated. |
| 296 | "status": "A String", # Status of the post. Only set for admin-level requests. |
| 297 | "id": "A String", # The identifier of this Post. |
| 298 | "location": { # The location for geotagged posts. |
| 299 | "name": "A String", # Location name. |
| 300 | "lat": 3.14, # Location's latitude. |
| 301 | "lng": 3.14, # Location's longitude. |
| 302 | "span": "A String", # Location's viewport span. Can be used when rendering a map preview. |
| 303 | }, |
| 304 | "title": "A String", # The title of the Post. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 305 | "kind": "A String", # The kind of this entity. Always blogger#post. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 306 | "author": { # The author of this Post. |
| 307 | "image": { # The creator's avatar. |
| 308 | "url": "A String", # The creator's avatar URL. |
| 309 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 310 | "id": "A String", # The identifier of the creator. |
| 311 | "url": "A String", # The URL of the creator's Profile page. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 312 | "displayName": "A String", # The display name. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 313 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 314 | }, |
| 315 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 316 | }, |
| 317 | "pages": { # The container of pages in this blog. |
| 318 | "totalItems": 42, # The count of pages in this blog. |
| 319 | "selfLink": "A String", # The URL of the container for pages in this blog. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 320 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 321 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 322 | "kind": "A String", # The kind of this entry. Always blogger#blog. |
| 323 | "status": "A String", # The status of the blog. |
| 324 | "customMetaData": "A String", # The JSON custom meta-data for the Blog. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 325 | "published": "A String", # RFC 3339 date-time when this blog was published. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 326 | "description": "A String", # The description of this blog. This is displayed underneath the title. |
| 327 | "updated": "A String", # RFC 3339 date-time when this blog was last updated. |
| 328 | "locale": { # The locale this Blog is set to. |
| 329 | "variant": "A String", # The language variant this blog is authored in. |
| 330 | "country": "A String", # The country this blog's locale is set to. |
| 331 | "language": "A String", # The language this blog is authored in. |
| 332 | }, |
| 333 | "id": "A String", # The identifier for this resource. |
| 334 | "name": "A String", # The name of this blog. This is displayed as the title. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 335 | }</pre> |
| 336 | </div> |
| 337 | |
| 338 | <div class="method"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 339 | <code class="details" id="listByUser">listByUser(userId, fetchUserInfo=None, status=None, view=None, role=None, x__xgafv=None)</code> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 340 | <pre>Lists blogs by user. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 341 | |
| 342 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 343 | userId: string, A parameter (required) |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 344 | fetchUserInfo: boolean, A parameter |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 345 | status: string, Default value of status is LIVE. (repeated) |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 346 | Allowed values |
| 347 | LIVE - |
| 348 | DELETED - |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 349 | view: string, A parameter |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 350 | Allowed values |
| 351 | VIEW_TYPE_UNSPECIFIED - |
| 352 | READER - |
| 353 | AUTHOR - |
| 354 | ADMIN - |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 355 | role: string, A parameter (repeated) |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 356 | Allowed values |
| 357 | VIEW_TYPE_UNSPECIFIED - |
| 358 | READER - |
| 359 | AUTHOR - |
| 360 | ADMIN - |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 361 | x__xgafv: string, V1 error format. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame] | 362 | Allowed values |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 363 | 1 - v1 error format |
| 364 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 365 | |
| 366 | Returns: |
| 367 | An object of the form: |
| 368 | |
| 369 | { |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 370 | "blogUserInfos": [ # Admin level list of blog per-user information. |
| 371 | { |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 372 | "blog": { # The Blog resource. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 373 | "url": "A String", # The URL where this blog is published. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 374 | "posts": { # The container of posts in this blog. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 375 | "totalItems": 42, # The count of posts in this blog. |
| 376 | "selfLink": "A String", # The URL of the container for posts in this blog. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 377 | "items": [ # The List of Posts for this Blog. |
| 378 | { |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 379 | "published": "A String", # RFC 3339 date-time when this Post was published. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 380 | "images": [ # Display image for the Post. |
| 381 | { |
| 382 | "url": "A String", |
| 383 | }, |
| 384 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 385 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 386 | "url": "A String", # The URL where this Post is displayed. |
| 387 | "content": "A String", # The content of the Post. May contain HTML markup. |
| 388 | "replies": { # The container of comments on this Post. |
| 389 | "totalItems": "A String", # The count of comments on this post. |
| 390 | "selfLink": "A String", # The URL of the comments on this post. |
| 391 | "items": [ # The List of Comments for this Post. |
| 392 | { |
| 393 | "content": "A String", # The actual content of the comment. May include HTML markup. |
| 394 | "post": { # Data about the post containing this comment. |
| 395 | "id": "A String", # The identifier of the post containing this comment. |
| 396 | }, |
| 397 | "kind": "A String", # The kind of this entry. Always blogger#comment. |
| 398 | "id": "A String", # The identifier for this resource. |
| 399 | "inReplyTo": { # Data about the comment this is in reply to. |
| 400 | "id": "A String", # The identified of the parent of this comment. |
| 401 | }, |
| 402 | "published": "A String", # RFC 3339 date-time when this comment was published. |
| 403 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 404 | "author": { # The author of this Comment. |
| 405 | "url": "A String", # The URL of the creator's Profile page. |
| 406 | "displayName": "A String", # The display name. |
| 407 | "image": { # The creator's avatar. |
| 408 | "url": "A String", # The creator's avatar URL. |
| 409 | }, |
| 410 | "id": "A String", # The identifier of the creator. |
| 411 | }, |
| 412 | "updated": "A String", # RFC 3339 date-time when this comment was last updated. |
| 413 | "blog": { # Data about the blog containing this comment. |
| 414 | "id": "A String", # The identifier of the blog containing this comment. |
| 415 | }, |
| 416 | "status": "A String", # The status of the comment (only populated for admin users). |
| 417 | }, |
| 418 | ], |
| 419 | }, |
| 420 | "readerComments": "A String", # Comment control and display setting for readers of this post. |
| 421 | "customMetaData": "A String", # The JSON meta-data for the Post. |
| 422 | "labels": [ # The list of labels this Post was tagged with. |
| 423 | "A String", |
| 424 | ], |
| 425 | "titleLink": "A String", # The title link URL, similar to atom's related link. |
| 426 | "etag": "A String", # Etag of the resource. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 427 | "blog": { # Data about the blog containing this Post. |
| 428 | "id": "A String", # The identifier of the Blog that contains this Post. |
| 429 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 430 | "updated": "A String", # RFC 3339 date-time when this Post was last updated. |
| 431 | "status": "A String", # Status of the post. Only set for admin-level requests. |
| 432 | "id": "A String", # The identifier of this Post. |
| 433 | "location": { # The location for geotagged posts. |
| 434 | "name": "A String", # Location name. |
| 435 | "lat": 3.14, # Location's latitude. |
| 436 | "lng": 3.14, # Location's longitude. |
| 437 | "span": "A String", # Location's viewport span. Can be used when rendering a map preview. |
| 438 | }, |
| 439 | "title": "A String", # The title of the Post. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 440 | "kind": "A String", # The kind of this entity. Always blogger#post. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 441 | "author": { # The author of this Post. |
| 442 | "image": { # The creator's avatar. |
| 443 | "url": "A String", # The creator's avatar URL. |
| 444 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 445 | "id": "A String", # The identifier of the creator. |
| 446 | "url": "A String", # The URL of the creator's Profile page. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 447 | "displayName": "A String", # The display name. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 448 | }, |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 449 | }, |
| 450 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 451 | }, |
| 452 | "pages": { # The container of pages in this blog. |
| 453 | "totalItems": 42, # The count of pages in this blog. |
| 454 | "selfLink": "A String", # The URL of the container for pages in this blog. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 455 | }, |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 456 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 457 | "kind": "A String", # The kind of this entry. Always blogger#blog. |
| 458 | "status": "A String", # The status of the blog. |
| 459 | "customMetaData": "A String", # The JSON custom meta-data for the Blog. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 460 | "published": "A String", # RFC 3339 date-time when this blog was published. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 461 | "description": "A String", # The description of this blog. This is displayed underneath the title. |
| 462 | "updated": "A String", # RFC 3339 date-time when this blog was last updated. |
| 463 | "locale": { # The locale this Blog is set to. |
| 464 | "variant": "A String", # The language variant this blog is authored in. |
| 465 | "country": "A String", # The country this blog's locale is set to. |
| 466 | "language": "A String", # The language this blog is authored in. |
| 467 | }, |
| 468 | "id": "A String", # The identifier for this resource. |
| 469 | "name": "A String", # The name of this blog. This is displayed as the title. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 470 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 471 | "blog_user_info": { # Information about a User for the Blog. |
| 472 | "blogId": "A String", # ID of the Blog resource. |
| 473 | "photosAlbumKey": "A String", # The Photo Album Key for the user when adding photos to the blog. |
| 474 | "role": "A String", # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER). |
| 475 | "kind": "A String", # The kind of this entity. Always blogger#blogPerUserInfo. |
| 476 | "hasAdminAccess": True or False, # True if the user has Admin level access to the blog. |
| 477 | "userId": "A String", # ID of the User. |
| 478 | }, |
| 479 | "kind": "A String", # The kind of this entity. Always blogger#blogUserInfo. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 480 | }, |
| 481 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 482 | "kind": "A String", # The kind of this entity. Always blogger#blogList. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 483 | "items": [ # The list of Blogs this user has Authorship or Admin rights over. |
| 484 | { |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 485 | "url": "A String", # The URL where this blog is published. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 486 | "posts": { # The container of posts in this blog. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 487 | "totalItems": 42, # The count of posts in this blog. |
| 488 | "selfLink": "A String", # The URL of the container for posts in this blog. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 489 | "items": [ # The List of Posts for this Blog. |
| 490 | { |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 491 | "published": "A String", # RFC 3339 date-time when this Post was published. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 492 | "images": [ # Display image for the Post. |
| 493 | { |
| 494 | "url": "A String", |
| 495 | }, |
| 496 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 497 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 498 | "url": "A String", # The URL where this Post is displayed. |
| 499 | "content": "A String", # The content of the Post. May contain HTML markup. |
| 500 | "replies": { # The container of comments on this Post. |
| 501 | "totalItems": "A String", # The count of comments on this post. |
| 502 | "selfLink": "A String", # The URL of the comments on this post. |
| 503 | "items": [ # The List of Comments for this Post. |
| 504 | { |
| 505 | "content": "A String", # The actual content of the comment. May include HTML markup. |
| 506 | "post": { # Data about the post containing this comment. |
| 507 | "id": "A String", # The identifier of the post containing this comment. |
| 508 | }, |
| 509 | "kind": "A String", # The kind of this entry. Always blogger#comment. |
| 510 | "id": "A String", # The identifier for this resource. |
| 511 | "inReplyTo": { # Data about the comment this is in reply to. |
| 512 | "id": "A String", # The identified of the parent of this comment. |
| 513 | }, |
| 514 | "published": "A String", # RFC 3339 date-time when this comment was published. |
| 515 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 516 | "author": { # The author of this Comment. |
| 517 | "url": "A String", # The URL of the creator's Profile page. |
| 518 | "displayName": "A String", # The display name. |
| 519 | "image": { # The creator's avatar. |
| 520 | "url": "A String", # The creator's avatar URL. |
| 521 | }, |
| 522 | "id": "A String", # The identifier of the creator. |
| 523 | }, |
| 524 | "updated": "A String", # RFC 3339 date-time when this comment was last updated. |
| 525 | "blog": { # Data about the blog containing this comment. |
| 526 | "id": "A String", # The identifier of the blog containing this comment. |
| 527 | }, |
| 528 | "status": "A String", # The status of the comment (only populated for admin users). |
| 529 | }, |
| 530 | ], |
| 531 | }, |
| 532 | "readerComments": "A String", # Comment control and display setting for readers of this post. |
| 533 | "customMetaData": "A String", # The JSON meta-data for the Post. |
| 534 | "labels": [ # The list of labels this Post was tagged with. |
| 535 | "A String", |
| 536 | ], |
| 537 | "titleLink": "A String", # The title link URL, similar to atom's related link. |
| 538 | "etag": "A String", # Etag of the resource. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 539 | "blog": { # Data about the blog containing this Post. |
| 540 | "id": "A String", # The identifier of the Blog that contains this Post. |
| 541 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 542 | "updated": "A String", # RFC 3339 date-time when this Post was last updated. |
| 543 | "status": "A String", # Status of the post. Only set for admin-level requests. |
| 544 | "id": "A String", # The identifier of this Post. |
| 545 | "location": { # The location for geotagged posts. |
| 546 | "name": "A String", # Location name. |
| 547 | "lat": 3.14, # Location's latitude. |
| 548 | "lng": 3.14, # Location's longitude. |
| 549 | "span": "A String", # Location's viewport span. Can be used when rendering a map preview. |
| 550 | }, |
| 551 | "title": "A String", # The title of the Post. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 552 | "kind": "A String", # The kind of this entity. Always blogger#post. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 553 | "author": { # The author of this Post. |
| 554 | "image": { # The creator's avatar. |
| 555 | "url": "A String", # The creator's avatar URL. |
| 556 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 557 | "id": "A String", # The identifier of the creator. |
| 558 | "url": "A String", # The URL of the creator's Profile page. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 559 | "displayName": "A String", # The display name. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 560 | }, |
| 561 | }, |
| 562 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 563 | }, |
| 564 | "pages": { # The container of pages in this blog. |
| 565 | "totalItems": 42, # The count of pages in this blog. |
| 566 | "selfLink": "A String", # The URL of the container for pages in this blog. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 567 | }, |
| 568 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 569 | "kind": "A String", # The kind of this entry. Always blogger#blog. |
| 570 | "status": "A String", # The status of the blog. |
| 571 | "customMetaData": "A String", # The JSON custom meta-data for the Blog. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 572 | "published": "A String", # RFC 3339 date-time when this blog was published. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 573 | "description": "A String", # The description of this blog. This is displayed underneath the title. |
| 574 | "updated": "A String", # RFC 3339 date-time when this blog was last updated. |
| 575 | "locale": { # The locale this Blog is set to. |
| 576 | "variant": "A String", # The language variant this blog is authored in. |
| 577 | "country": "A String", # The country this blog's locale is set to. |
| 578 | "language": "A String", # The language this blog is authored in. |
| 579 | }, |
| 580 | "id": "A String", # The identifier for this resource. |
| 581 | "name": "A String", # The name of this blog. This is displayed as the title. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 582 | }, |
| 583 | ], |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 584 | }</pre> |
| 585 | </div> |
| 586 | |
| 587 | </body></html> |