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