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