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