blob: f38d3d9ec0fb2ab7098fc5330c68f0f2c88735ee [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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'Mearadd494642020-05-01 07:42:23 -070075<h1><a href="blogger_v3.html">Blogger API v3</a> . <a href="blogger_v3.posts.html">posts</a></h1>
John Asmuth614db982014-04-24 15:46:26 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#delete">delete(blogId, postId, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a post by blog id and post id.</p>
John Asmuth614db982014-04-24 15:46:26 -040080<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#get">get(blogId, postId, maxComments=None, fetchImages=None, fetchBody=None, x__xgafv=None, view=None)</a></code></p>
82<p class="firstline">Gets a post by blog id and post id</p>
John Asmuth614db982014-04-24 15:46:26 -040083<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#getByPath">getByPath(blogId, path, x__xgafv=None, maxComments=None, view=None)</a></code></p>
85<p class="firstline">Gets a post by path.</p>
John Asmuth614db982014-04-24 15:46:26 -040086<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#insert">insert(blogId, body=None, isDraft=None, fetchBody=None, x__xgafv=None, fetchImages=None)</a></code></p>
88<p class="firstline">Inserts a post.</p>
John Asmuth614db982014-04-24 15:46:26 -040089<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#list">list(blogId, orderBy=None, startDate=None, endDate=None, labels=None, x__xgafv=None, fetchImages=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</a></code></p>
91<p class="firstline">Lists posts.</p>
John Asmuth614db982014-04-24 15:46:26 -040092<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#patch">patch(blogId, postId, body=None, x__xgafv=None, publish=None, fetchImages=None, revert=None, fetchBody=None, maxComments=None)</a></code></p>
97<p class="firstline">Patches a post.</p>
John Asmuth614db982014-04-24 15:46:26 -040098<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#publish">publish(blogId, postId, publishDate=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Publishes a post.</p>
John Asmuth614db982014-04-24 15:46:26 -0400101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#revert">revert(blogId, postId, x__xgafv=None)</a></code></p>
103<p class="firstline">Reverts a published or scheduled post to draft state.</p>
John Asmuth614db982014-04-24 15:46:26 -0400104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700105 <code><a href="#search">search(blogId, q, orderBy=None, x__xgafv=None, fetchBodies=None)</a></code></p>
106<p class="firstline">Searches for posts matching given query terms in the specified blog.</p>
John Asmuth614db982014-04-24 15:46:26 -0400107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700108 <code><a href="#update">update(blogId, postId, body=None, x__xgafv=None, publish=None, fetchImages=None, revert=None, fetchBody=None, maxComments=None)</a></code></p>
109<p class="firstline">Updates a post by blog id and post id.</p>
John Asmuth614db982014-04-24 15:46:26 -0400110<h3>Method Details</h3>
111<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700112 <code class="details" id="delete">delete(blogId, postId, x__xgafv=None)</code>
113 <pre>Deletes a post by blog id and post id.
John Asmuth614db982014-04-24 15:46:26 -0400114
115Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700116 blogId: string, A parameter (required)
117 postId: string, A parameter (required)
118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400122</pre>
123</div>
124
125<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700126 <code class="details" id="get">get(blogId, postId, maxComments=None, fetchImages=None, fetchBody=None, x__xgafv=None, view=None)</code>
127 <pre>Gets a post by blog id and post id
John Asmuth614db982014-04-24 15:46:26 -0400128
129Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700130 blogId: string, A parameter (required)
131 postId: string, A parameter (required)
132 maxComments: integer, A parameter
133 fetchImages: boolean, A parameter
134 fetchBody: boolean, A parameter
135 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400136 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700137 1 - v1 error format
138 2 - v2 error format
139 view: string, A parameter
John Asmuth614db982014-04-24 15:46:26 -0400140
141Returns:
142 An object of the form:
143
144 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700145 "status": "A String", # Status of the post. Only set for admin-level requests.
146 "blog": { # Data about the blog containing this Post.
147 "id": "A String", # The identifier of the Blog that contains this Post.
148 },
149 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
John Asmuth614db982014-04-24 15:46:26 -0400150 "titleLink": "A String", # The title link URL, similar to atom's related link.
151 "author": { # The author of this Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700152 "url": "A String", # The URL of the creator's Profile page.
153 "image": { # The creator's avatar.
154 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400155 },
156 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700157 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400158 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700159 "title": "A String", # The title of the Post.
John Asmuth614db982014-04-24 15:46:26 -0400160 "replies": { # The container of comments on this Post.
161 "totalItems": "A String", # The count of comments on this post.
162 "items": [ # The List of Comments for this Post.
163 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700164 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400165 "inReplyTo": { # Data about the comment this is in reply to.
166 "id": "A String", # The identified of the parent of this comment.
167 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700168 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400169 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700170 "url": "A String", # The URL of the creator's Profile page.
171 "image": { # The creator's avatar.
172 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400173 },
174 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700175 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400176 },
177 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
178 "blog": { # Data about the blog containing this comment.
179 "id": "A String", # The identifier of the blog containing this comment.
180 },
181 "published": "A String", # RFC 3339 date-time when this comment was published.
182 "post": { # Data about the post containing this comment.
183 "id": "A String", # The identifier of the post containing this comment.
184 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700185 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400186 "id": "A String", # The identifier for this resource.
187 "selfLink": "A String", # The API REST URL to fetch this resource from.
188 },
189 ],
190 "selfLink": "A String", # The URL of the comments on this post.
191 },
Craig Citro065b5302014-08-14 00:47:23 -0700192 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400193 "labels": [ # The list of labels this Post was tagged with.
194 "A String",
195 ],
196 "customMetaData": "A String", # The JSON meta-data for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700197 "kind": "A String", # The kind of this entity. Always blogger#post.
198 "content": "A String", # The content of the Post. May contain HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400199 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700200 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400201 "location": { # The location for geotagged posts.
202 "lat": 3.14, # Location's latitude.
203 "lng": 3.14, # Location's longitude.
204 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
205 "name": "A String", # Location name.
206 },
207 "published": "A String", # RFC 3339 date-time when this Post was published.
208 "images": [ # Display image for the Post.
209 {
210 "url": "A String",
211 },
212 ],
John Asmuth614db982014-04-24 15:46:26 -0400213 "id": "A String", # The identifier of this Post.
214 "selfLink": "A String", # The API REST URL to fetch this resource from.
215 }</pre>
216</div>
217
218<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700219 <code class="details" id="getByPath">getByPath(blogId, path, x__xgafv=None, maxComments=None, view=None)</code>
220 <pre>Gets a post by path.
John Asmuth614db982014-04-24 15:46:26 -0400221
222Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700223 blogId: string, A parameter (required)
224 path: string, A parameter (required)
225 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400226 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700227 1 - v1 error format
228 2 - v2 error format
229 maxComments: integer, A parameter
230 view: string, A parameter
John Asmuth614db982014-04-24 15:46:26 -0400231
232Returns:
233 An object of the form:
234
235 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700236 "status": "A String", # Status of the post. Only set for admin-level requests.
237 "blog": { # Data about the blog containing this Post.
238 "id": "A String", # The identifier of the Blog that contains this Post.
239 },
240 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
John Asmuth614db982014-04-24 15:46:26 -0400241 "titleLink": "A String", # The title link URL, similar to atom's related link.
242 "author": { # The author of this Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700243 "url": "A String", # The URL of the creator's Profile page.
244 "image": { # The creator's avatar.
245 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400246 },
247 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700248 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400249 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700250 "title": "A String", # The title of the Post.
John Asmuth614db982014-04-24 15:46:26 -0400251 "replies": { # The container of 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 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700255 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400256 "inReplyTo": { # Data about the comment this is in reply to.
257 "id": "A String", # The identified of the parent of this comment.
258 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700259 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400260 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700261 "url": "A String", # The URL of the creator's Profile page.
262 "image": { # The creator's avatar.
263 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400264 },
265 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700266 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400267 },
268 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
269 "blog": { # Data about the blog containing this comment.
270 "id": "A String", # The identifier of the blog containing this comment.
271 },
272 "published": "A String", # RFC 3339 date-time when this comment was published.
273 "post": { # Data about the post containing this comment.
274 "id": "A String", # The identifier of the post containing this comment.
275 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700276 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400277 "id": "A String", # The identifier for this resource.
278 "selfLink": "A String", # The API REST URL to fetch this resource from.
279 },
280 ],
281 "selfLink": "A String", # The URL of the comments on this post.
282 },
Craig Citro065b5302014-08-14 00:47:23 -0700283 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400284 "labels": [ # The list of labels this Post was tagged with.
285 "A String",
286 ],
287 "customMetaData": "A String", # The JSON meta-data for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700288 "kind": "A String", # The kind of this entity. Always blogger#post.
289 "content": "A String", # The content of the Post. May contain HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400290 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700291 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400292 "location": { # The location for geotagged posts.
293 "lat": 3.14, # Location's latitude.
294 "lng": 3.14, # Location's longitude.
295 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
296 "name": "A String", # Location name.
297 },
298 "published": "A String", # RFC 3339 date-time when this Post was published.
299 "images": [ # Display image for the Post.
300 {
301 "url": "A String",
302 },
303 ],
John Asmuth614db982014-04-24 15:46:26 -0400304 "id": "A String", # The identifier of this Post.
305 "selfLink": "A String", # The API REST URL to fetch this resource from.
306 }</pre>
307</div>
308
309<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700310 <code class="details" id="insert">insert(blogId, body=None, isDraft=None, fetchBody=None, x__xgafv=None, fetchImages=None)</code>
311 <pre>Inserts a post.
John Asmuth614db982014-04-24 15:46:26 -0400312
313Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700314 blogId: string, A parameter (required)
315 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400316 The object takes the form of:
317
318{
Dan O'Mearadd494642020-05-01 07:42:23 -0700319 "status": "A String", # Status of the post. Only set for admin-level requests.
320 "blog": { # Data about the blog containing this Post.
321 "id": "A String", # The identifier of the Blog that contains this Post.
322 },
323 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
John Asmuth614db982014-04-24 15:46:26 -0400324 "titleLink": "A String", # The title link URL, similar to atom's related link.
325 "author": { # The author of this Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700326 "url": "A String", # The URL of the creator's Profile page.
327 "image": { # The creator's avatar.
328 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400329 },
330 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700331 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400332 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700333 "title": "A String", # The title of the Post.
John Asmuth614db982014-04-24 15:46:26 -0400334 "replies": { # The container of comments on this Post.
335 "totalItems": "A String", # The count of comments on this post.
336 "items": [ # The List of Comments for this Post.
337 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700338 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400339 "inReplyTo": { # Data about the comment this is in reply to.
340 "id": "A String", # The identified of the parent of this comment.
341 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700342 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400343 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700344 "url": "A String", # The URL of the creator's Profile page.
345 "image": { # The creator's avatar.
346 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400347 },
348 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700349 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400350 },
351 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
352 "blog": { # Data about the blog containing this comment.
353 "id": "A String", # The identifier of the blog containing this comment.
354 },
355 "published": "A String", # RFC 3339 date-time when this comment was published.
356 "post": { # Data about the post containing this comment.
357 "id": "A String", # The identifier of the post containing this comment.
358 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700359 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400360 "id": "A String", # The identifier for this resource.
361 "selfLink": "A String", # The API REST URL to fetch this resource from.
362 },
363 ],
364 "selfLink": "A String", # The URL of the comments on this post.
365 },
Craig Citro065b5302014-08-14 00:47:23 -0700366 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400367 "labels": [ # The list of labels this Post was tagged with.
368 "A String",
369 ],
370 "customMetaData": "A String", # The JSON meta-data for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700371 "kind": "A String", # The kind of this entity. Always blogger#post.
372 "content": "A String", # The content of the Post. May contain HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400373 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700374 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400375 "location": { # The location for geotagged posts.
376 "lat": 3.14, # Location's latitude.
377 "lng": 3.14, # Location's longitude.
378 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
379 "name": "A String", # Location name.
380 },
381 "published": "A String", # RFC 3339 date-time when this Post was published.
382 "images": [ # Display image for the Post.
383 {
384 "url": "A String",
385 },
386 ],
John Asmuth614db982014-04-24 15:46:26 -0400387 "id": "A String", # The identifier of this Post.
388 "selfLink": "A String", # The API REST URL to fetch this resource from.
389}
390
Dan O'Mearadd494642020-05-01 07:42:23 -0700391 isDraft: boolean, A parameter
392 fetchBody: boolean, A parameter
393 x__xgafv: string, V1 error format.
394 Allowed values
395 1 - v1 error format
396 2 - v2 error format
397 fetchImages: boolean, A parameter
John Asmuth614db982014-04-24 15:46:26 -0400398
399Returns:
400 An object of the form:
401
402 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700403 "status": "A String", # Status of the post. Only set for admin-level requests.
404 "blog": { # Data about the blog containing this Post.
405 "id": "A String", # The identifier of the Blog that contains this Post.
406 },
407 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
John Asmuth614db982014-04-24 15:46:26 -0400408 "titleLink": "A String", # The title link URL, similar to atom's related link.
409 "author": { # The author of this Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700410 "url": "A String", # The URL of the creator's Profile page.
411 "image": { # The creator's avatar.
412 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400413 },
414 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700415 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400416 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700417 "title": "A String", # The title of the Post.
John Asmuth614db982014-04-24 15:46:26 -0400418 "replies": { # The container of comments on this Post.
419 "totalItems": "A String", # The count of comments on this post.
420 "items": [ # The List of Comments for this Post.
421 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700422 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400423 "inReplyTo": { # Data about the comment this is in reply to.
424 "id": "A String", # The identified of the parent of this comment.
425 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700426 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400427 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700428 "url": "A String", # The URL of the creator's Profile page.
429 "image": { # The creator's avatar.
430 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400431 },
432 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700433 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400434 },
435 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
436 "blog": { # Data about the blog containing this comment.
437 "id": "A String", # The identifier of the blog containing this comment.
438 },
439 "published": "A String", # RFC 3339 date-time when this comment was published.
440 "post": { # Data about the post containing this comment.
441 "id": "A String", # The identifier of the post containing this comment.
442 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700443 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400444 "id": "A String", # The identifier for this resource.
445 "selfLink": "A String", # The API REST URL to fetch this resource from.
446 },
447 ],
448 "selfLink": "A String", # The URL of the comments on this post.
449 },
Craig Citro065b5302014-08-14 00:47:23 -0700450 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400451 "labels": [ # The list of labels this Post was tagged with.
452 "A String",
453 ],
454 "customMetaData": "A String", # The JSON meta-data for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700455 "kind": "A String", # The kind of this entity. Always blogger#post.
456 "content": "A String", # The content of the Post. May contain HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400457 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700458 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400459 "location": { # The location for geotagged posts.
460 "lat": 3.14, # Location's latitude.
461 "lng": 3.14, # Location's longitude.
462 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
463 "name": "A String", # Location name.
464 },
465 "published": "A String", # RFC 3339 date-time when this Post was published.
466 "images": [ # Display image for the Post.
467 {
468 "url": "A String",
469 },
470 ],
John Asmuth614db982014-04-24 15:46:26 -0400471 "id": "A String", # The identifier of this Post.
472 "selfLink": "A String", # The API REST URL to fetch this resource from.
473 }</pre>
474</div>
475
476<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700477 <code class="details" id="list">list(blogId, orderBy=None, startDate=None, endDate=None, labels=None, x__xgafv=None, fetchImages=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</code>
478 <pre>Lists posts.
John Asmuth614db982014-04-24 15:46:26 -0400479
480Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700481 blogId: string, A parameter (required)
482 orderBy: string, A parameter
483 startDate: string, A parameter
484 endDate: string, A parameter
485 labels: string, A parameter
486 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400487 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700488 1 - v1 error format
489 2 - v2 error format
490 fetchImages: boolean, A parameter
491 pageToken: string, A parameter
492 status: string, A parameter (repeated)
493 maxResults: integer, A parameter
494 fetchBodies: boolean, A parameter
495 view: string, A parameter
John Asmuth614db982014-04-24 15:46:26 -0400496
497Returns:
498 An object of the form:
499
500 {
501 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
502 "items": [ # The list of Posts for this Blog.
503 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700504 "status": "A String", # Status of the post. Only set for admin-level requests.
505 "blog": { # Data about the blog containing this Post.
506 "id": "A String", # The identifier of the Blog that contains this Post.
507 },
508 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
John Asmuth614db982014-04-24 15:46:26 -0400509 "titleLink": "A String", # The title link URL, similar to atom's related link.
510 "author": { # The author of this Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700511 "url": "A String", # The URL of the creator's Profile page.
512 "image": { # The creator's avatar.
513 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400514 },
515 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700516 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400517 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700518 "title": "A String", # The title of the Post.
John Asmuth614db982014-04-24 15:46:26 -0400519 "replies": { # The container of comments on this Post.
520 "totalItems": "A String", # The count of comments on this post.
521 "items": [ # The List of Comments for this Post.
522 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700523 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400524 "inReplyTo": { # Data about the comment this is in reply to.
525 "id": "A String", # The identified of the parent of this comment.
526 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700527 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400528 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700529 "url": "A String", # The URL of the creator's Profile page.
530 "image": { # The creator's avatar.
531 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400532 },
533 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700534 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400535 },
536 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
537 "blog": { # Data about the blog containing this comment.
538 "id": "A String", # The identifier of the blog containing this comment.
539 },
540 "published": "A String", # RFC 3339 date-time when this comment was published.
541 "post": { # Data about the post containing this comment.
542 "id": "A String", # The identifier of the post containing this comment.
543 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700544 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400545 "id": "A String", # The identifier for this resource.
546 "selfLink": "A String", # The API REST URL to fetch this resource from.
547 },
548 ],
549 "selfLink": "A String", # The URL of the comments on this post.
550 },
Craig Citro065b5302014-08-14 00:47:23 -0700551 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400552 "labels": [ # The list of labels this Post was tagged with.
553 "A String",
554 ],
555 "customMetaData": "A String", # The JSON meta-data for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700556 "kind": "A String", # The kind of this entity. Always blogger#post.
557 "content": "A String", # The content of the Post. May contain HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400558 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700559 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400560 "location": { # The location for geotagged posts.
561 "lat": 3.14, # Location's latitude.
562 "lng": 3.14, # Location's longitude.
563 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
564 "name": "A String", # Location name.
565 },
566 "published": "A String", # RFC 3339 date-time when this Post was published.
567 "images": [ # Display image for the Post.
568 {
569 "url": "A String",
570 },
571 ],
John Asmuth614db982014-04-24 15:46:26 -0400572 "id": "A String", # The identifier of this Post.
573 "selfLink": "A String", # The API REST URL to fetch this resource from.
574 },
575 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700576 "kind": "A String", # The kind of this entity. Always blogger#postList.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000577 "etag": "A String", # Etag of the response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700578 "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
John Asmuth614db982014-04-24 15:46:26 -0400579 }</pre>
580</div>
581
582<div class="method">
583 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
584 <pre>Retrieves the next page of results.
585
586Args:
587 previous_request: The request for the previous page. (required)
588 previous_response: The response from the request for the previous page. (required)
589
590Returns:
591 A request object that you can call 'execute()' on to request the next
592 page. Returns None if there are no more items in the collection.
593 </pre>
594</div>
595
596<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700597 <code class="details" id="patch">patch(blogId, postId, body=None, x__xgafv=None, publish=None, fetchImages=None, revert=None, fetchBody=None, maxComments=None)</code>
598 <pre>Patches a post.
John Asmuth614db982014-04-24 15:46:26 -0400599
600Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700601 blogId: string, A parameter (required)
602 postId: string, A parameter (required)
603 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400604 The object takes the form of:
605
606{
Dan O'Mearadd494642020-05-01 07:42:23 -0700607 "status": "A String", # Status of the post. Only set for admin-level requests.
608 "blog": { # Data about the blog containing this Post.
609 "id": "A String", # The identifier of the Blog that contains this Post.
610 },
611 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
John Asmuth614db982014-04-24 15:46:26 -0400612 "titleLink": "A String", # The title link URL, similar to atom's related link.
613 "author": { # The author of this Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700614 "url": "A String", # The URL of the creator's Profile page.
615 "image": { # The creator's avatar.
616 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400617 },
618 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700619 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400620 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700621 "title": "A String", # The title of the Post.
John Asmuth614db982014-04-24 15:46:26 -0400622 "replies": { # The container of comments on this Post.
623 "totalItems": "A String", # The count of comments on this post.
624 "items": [ # The List of Comments for this Post.
625 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700626 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400627 "inReplyTo": { # Data about the comment this is in reply to.
628 "id": "A String", # The identified of the parent of this comment.
629 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700630 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400631 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700632 "url": "A String", # The URL of the creator's Profile page.
633 "image": { # The creator's avatar.
634 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400635 },
636 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700637 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400638 },
639 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
640 "blog": { # Data about the blog containing this comment.
641 "id": "A String", # The identifier of the blog containing this comment.
642 },
643 "published": "A String", # RFC 3339 date-time when this comment was published.
644 "post": { # Data about the post containing this comment.
645 "id": "A String", # The identifier of the post containing this comment.
646 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700647 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400648 "id": "A String", # The identifier for this resource.
649 "selfLink": "A String", # The API REST URL to fetch this resource from.
650 },
651 ],
652 "selfLink": "A String", # The URL of the comments on this post.
653 },
Craig Citro065b5302014-08-14 00:47:23 -0700654 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -0400655 "labels": [ # The list of labels this Post was tagged with.
656 "A String",
657 ],
658 "customMetaData": "A String", # The JSON meta-data for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700659 "kind": "A String", # The kind of this entity. Always blogger#post.
660 "content": "A String", # The content of the Post. May contain HTML markup.
John Asmuth614db982014-04-24 15:46:26 -0400661 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -0700662 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -0400663 "location": { # The location for geotagged posts.
664 "lat": 3.14, # Location's latitude.
665 "lng": 3.14, # Location's longitude.
666 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
667 "name": "A String", # Location name.
668 },
669 "published": "A String", # RFC 3339 date-time when this Post was published.
670 "images": [ # Display image for the Post.
671 {
672 "url": "A String",
673 },
674 ],
John Asmuth614db982014-04-24 15:46:26 -0400675 "id": "A String", # The identifier of this Post.
676 "selfLink": "A String", # The API REST URL to fetch this resource from.
677}
678
Dan O'Mearadd494642020-05-01 07:42:23 -0700679 x__xgafv: string, V1 error format.
John Asmuth614db982014-04-24 15:46:26 -0400680 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700681 1 - v1 error format
682 2 - v2 error format
683 publish: boolean, A parameter
684 fetchImages: boolean, A parameter
685 revert: boolean, A parameter
686 fetchBody: boolean, A parameter
687 maxComments: integer, A parameter
688
689Returns:
690 An object of the form:
691
692 {
693 "status": "A String", # Status of the post. Only set for admin-level requests.
694 "blog": { # Data about the blog containing this Post.
695 "id": "A String", # The identifier of the Blog that contains this Post.
696 },
697 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
698 "titleLink": "A String", # The title link URL, similar to atom's related link.
699 "author": { # The author of this Post.
700 "url": "A String", # The URL of the creator's Profile page.
701 "image": { # The creator's avatar.
702 "url": "A String", # The creator's avatar URL.
703 },
704 "displayName": "A String", # The display name.
705 "id": "A String", # The identifier of the creator.
706 },
707 "title": "A String", # The title of the Post.
708 "replies": { # The container of comments on this Post.
709 "totalItems": "A String", # The count of comments on this post.
710 "items": [ # The List of Comments for this Post.
711 {
712 "status": "A String", # The status of the comment (only populated for admin users).
713 "inReplyTo": { # Data about the comment this is in reply to.
714 "id": "A String", # The identified of the parent of this comment.
715 },
716 "kind": "A String", # The kind of this entry. Always blogger#comment.
717 "author": { # The author of this Comment.
718 "url": "A String", # The URL of the creator's Profile page.
719 "image": { # The creator's avatar.
720 "url": "A String", # The creator's avatar URL.
721 },
722 "displayName": "A String", # The display name.
723 "id": "A String", # The identifier of the creator.
724 },
725 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
726 "blog": { # Data about the blog containing this comment.
727 "id": "A String", # The identifier of the blog containing this comment.
728 },
729 "published": "A String", # RFC 3339 date-time when this comment was published.
730 "post": { # Data about the post containing this comment.
731 "id": "A String", # The identifier of the post containing this comment.
732 },
733 "content": "A String", # The actual content of the comment. May include HTML markup.
734 "id": "A String", # The identifier for this resource.
735 "selfLink": "A String", # The API REST URL to fetch this resource from.
736 },
737 ],
738 "selfLink": "A String", # The URL of the comments on this post.
739 },
740 "readerComments": "A String", # Comment control and display setting for readers of this post.
741 "labels": [ # The list of labels this Post was tagged with.
742 "A String",
743 ],
744 "customMetaData": "A String", # The JSON meta-data for the Post.
745 "kind": "A String", # The kind of this entity. Always blogger#post.
746 "content": "A String", # The content of the Post. May contain HTML markup.
747 "url": "A String", # The URL where this Post is displayed.
748 "etag": "A String", # Etag of the resource.
749 "location": { # The location for geotagged posts.
750 "lat": 3.14, # Location's latitude.
751 "lng": 3.14, # Location's longitude.
752 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
753 "name": "A String", # Location name.
754 },
755 "published": "A String", # RFC 3339 date-time when this Post was published.
756 "images": [ # Display image for the Post.
757 {
758 "url": "A String",
759 },
760 ],
761 "id": "A String", # The identifier of this Post.
762 "selfLink": "A String", # The API REST URL to fetch this resource from.
763 }</pre>
764</div>
765
766<div class="method">
767 <code class="details" id="publish">publish(blogId, postId, publishDate=None, x__xgafv=None)</code>
768 <pre>Publishes a post.
769
770Args:
771 blogId: string, A parameter (required)
772 postId: string, A parameter (required)
773 publishDate: string, A parameter
774 x__xgafv: string, V1 error format.
775 Allowed values
776 1 - v1 error format
777 2 - v2 error format
778
779Returns:
780 An object of the form:
781
782 {
783 "status": "A String", # Status of the post. Only set for admin-level requests.
784 "blog": { # Data about the blog containing this Post.
785 "id": "A String", # The identifier of the Blog that contains this Post.
786 },
787 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
788 "titleLink": "A String", # The title link URL, similar to atom's related link.
789 "author": { # The author of this Post.
790 "url": "A String", # The URL of the creator's Profile page.
791 "image": { # The creator's avatar.
792 "url": "A String", # The creator's avatar URL.
793 },
794 "displayName": "A String", # The display name.
795 "id": "A String", # The identifier of the creator.
796 },
797 "title": "A String", # The title of the Post.
798 "replies": { # The container of comments on this Post.
799 "totalItems": "A String", # The count of comments on this post.
800 "items": [ # The List of Comments for this Post.
801 {
802 "status": "A String", # The status of the comment (only populated for admin users).
803 "inReplyTo": { # Data about the comment this is in reply to.
804 "id": "A String", # The identified of the parent of this comment.
805 },
806 "kind": "A String", # The kind of this entry. Always blogger#comment.
807 "author": { # The author of this Comment.
808 "url": "A String", # The URL of the creator's Profile page.
809 "image": { # The creator's avatar.
810 "url": "A String", # The creator's avatar URL.
811 },
812 "displayName": "A String", # The display name.
813 "id": "A String", # The identifier of the creator.
814 },
815 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
816 "blog": { # Data about the blog containing this comment.
817 "id": "A String", # The identifier of the blog containing this comment.
818 },
819 "published": "A String", # RFC 3339 date-time when this comment was published.
820 "post": { # Data about the post containing this comment.
821 "id": "A String", # The identifier of the post containing this comment.
822 },
823 "content": "A String", # The actual content of the comment. May include HTML markup.
824 "id": "A String", # The identifier for this resource.
825 "selfLink": "A String", # The API REST URL to fetch this resource from.
826 },
827 ],
828 "selfLink": "A String", # The URL of the comments on this post.
829 },
830 "readerComments": "A String", # Comment control and display setting for readers of this post.
831 "labels": [ # The list of labels this Post was tagged with.
832 "A String",
833 ],
834 "customMetaData": "A String", # The JSON meta-data for the Post.
835 "kind": "A String", # The kind of this entity. Always blogger#post.
836 "content": "A String", # The content of the Post. May contain HTML markup.
837 "url": "A String", # The URL where this Post is displayed.
838 "etag": "A String", # Etag of the resource.
839 "location": { # The location for geotagged posts.
840 "lat": 3.14, # Location's latitude.
841 "lng": 3.14, # Location's longitude.
842 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
843 "name": "A String", # Location name.
844 },
845 "published": "A String", # RFC 3339 date-time when this Post was published.
846 "images": [ # Display image for the Post.
847 {
848 "url": "A String",
849 },
850 ],
851 "id": "A String", # The identifier of this Post.
852 "selfLink": "A String", # The API REST URL to fetch this resource from.
853 }</pre>
854</div>
855
856<div class="method">
857 <code class="details" id="revert">revert(blogId, postId, x__xgafv=None)</code>
858 <pre>Reverts a published or scheduled post to draft state.
859
860Args:
861 blogId: string, A parameter (required)
862 postId: string, A parameter (required)
863 x__xgafv: string, V1 error format.
864 Allowed values
865 1 - v1 error format
866 2 - v2 error format
867
868Returns:
869 An object of the form:
870
871 {
872 "status": "A String", # Status of the post. Only set for admin-level requests.
873 "blog": { # Data about the blog containing this Post.
874 "id": "A String", # The identifier of the Blog that contains this Post.
875 },
876 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
877 "titleLink": "A String", # The title link URL, similar to atom's related link.
878 "author": { # The author of this Post.
879 "url": "A String", # The URL of the creator's Profile page.
880 "image": { # The creator's avatar.
881 "url": "A String", # The creator's avatar URL.
882 },
883 "displayName": "A String", # The display name.
884 "id": "A String", # The identifier of the creator.
885 },
886 "title": "A String", # The title of the Post.
887 "replies": { # The container of comments on this Post.
888 "totalItems": "A String", # The count of comments on this post.
889 "items": [ # The List of Comments for this Post.
890 {
891 "status": "A String", # The status of the comment (only populated for admin users).
892 "inReplyTo": { # Data about the comment this is in reply to.
893 "id": "A String", # The identified of the parent of this comment.
894 },
895 "kind": "A String", # The kind of this entry. Always blogger#comment.
896 "author": { # The author of this Comment.
897 "url": "A String", # The URL of the creator's Profile page.
898 "image": { # The creator's avatar.
899 "url": "A String", # The creator's avatar URL.
900 },
901 "displayName": "A String", # The display name.
902 "id": "A String", # The identifier of the creator.
903 },
904 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
905 "blog": { # Data about the blog containing this comment.
906 "id": "A String", # The identifier of the blog containing this comment.
907 },
908 "published": "A String", # RFC 3339 date-time when this comment was published.
909 "post": { # Data about the post containing this comment.
910 "id": "A String", # The identifier of the post containing this comment.
911 },
912 "content": "A String", # The actual content of the comment. May include HTML markup.
913 "id": "A String", # The identifier for this resource.
914 "selfLink": "A String", # The API REST URL to fetch this resource from.
915 },
916 ],
917 "selfLink": "A String", # The URL of the comments on this post.
918 },
919 "readerComments": "A String", # Comment control and display setting for readers of this post.
920 "labels": [ # The list of labels this Post was tagged with.
921 "A String",
922 ],
923 "customMetaData": "A String", # The JSON meta-data for the Post.
924 "kind": "A String", # The kind of this entity. Always blogger#post.
925 "content": "A String", # The content of the Post. May contain HTML markup.
926 "url": "A String", # The URL where this Post is displayed.
927 "etag": "A String", # Etag of the resource.
928 "location": { # The location for geotagged posts.
929 "lat": 3.14, # Location's latitude.
930 "lng": 3.14, # Location's longitude.
931 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
932 "name": "A String", # Location name.
933 },
934 "published": "A String", # RFC 3339 date-time when this Post was published.
935 "images": [ # Display image for the Post.
936 {
937 "url": "A String",
938 },
939 ],
940 "id": "A String", # The identifier of this Post.
941 "selfLink": "A String", # The API REST URL to fetch this resource from.
942 }</pre>
943</div>
944
945<div class="method">
946 <code class="details" id="search">search(blogId, q, orderBy=None, x__xgafv=None, fetchBodies=None)</code>
947 <pre>Searches for posts matching given query terms in the specified blog.
948
949Args:
950 blogId: string, A parameter (required)
951 q: string, A parameter (required)
952 orderBy: string, A parameter
953 x__xgafv: string, V1 error format.
954 Allowed values
955 1 - v1 error format
956 2 - v2 error format
957 fetchBodies: boolean, A parameter
John Asmuth614db982014-04-24 15:46:26 -0400958
959Returns:
960 An object of the form:
961
962 {
963 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
964 "items": [ # The list of Posts for this Blog.
965 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700966 "status": "A String", # Status of the post. Only set for admin-level requests.
967 "blog": { # Data about the blog containing this Post.
968 "id": "A String", # The identifier of the Blog that contains this Post.
969 },
970 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
John Asmuth614db982014-04-24 15:46:26 -0400971 "titleLink": "A String", # The title link URL, similar to atom's related link.
972 "author": { # The author of this Post.
Dan O'Mearadd494642020-05-01 07:42:23 -0700973 "url": "A String", # The URL of the creator's Profile page.
974 "image": { # The creator's avatar.
975 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400976 },
977 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700978 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400979 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700980 "title": "A String", # The title of the Post.
John Asmuth614db982014-04-24 15:46:26 -0400981 "replies": { # The container of comments on this Post.
982 "totalItems": "A String", # The count of comments on this post.
983 "items": [ # The List of Comments for this Post.
984 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700985 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -0400986 "inReplyTo": { # Data about the comment this is in reply to.
987 "id": "A String", # The identified of the parent of this comment.
988 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700989 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -0400990 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700991 "url": "A String", # The URL of the creator's Profile page.
992 "image": { # The creator's avatar.
993 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -0400994 },
995 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -0700996 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400997 },
998 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
999 "blog": { # Data about the blog containing this comment.
1000 "id": "A String", # The identifier of the blog containing this comment.
1001 },
1002 "published": "A String", # RFC 3339 date-time when this comment was published.
1003 "post": { # Data about the post containing this comment.
1004 "id": "A String", # The identifier of the post containing this comment.
1005 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001006 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -04001007 "id": "A String", # The identifier for this resource.
1008 "selfLink": "A String", # The API REST URL to fetch this resource from.
1009 },
1010 ],
1011 "selfLink": "A String", # The URL of the comments on this post.
1012 },
Craig Citro065b5302014-08-14 00:47:23 -07001013 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -04001014 "labels": [ # The list of labels this Post was tagged with.
1015 "A String",
1016 ],
1017 "customMetaData": "A String", # The JSON meta-data for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -07001018 "kind": "A String", # The kind of this entity. Always blogger#post.
1019 "content": "A String", # The content of the Post. May contain HTML markup.
John Asmuth614db982014-04-24 15:46:26 -04001020 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -07001021 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -04001022 "location": { # The location for geotagged posts.
1023 "lat": 3.14, # Location's latitude.
1024 "lng": 3.14, # Location's longitude.
1025 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
1026 "name": "A String", # Location name.
1027 },
1028 "published": "A String", # RFC 3339 date-time when this Post was published.
1029 "images": [ # Display image for the Post.
1030 {
1031 "url": "A String",
1032 },
1033 ],
John Asmuth614db982014-04-24 15:46:26 -04001034 "id": "A String", # The identifier of this Post.
1035 "selfLink": "A String", # The API REST URL to fetch this resource from.
1036 },
1037 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001038 "kind": "A String", # The kind of this entity. Always blogger#postList.
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001039 "etag": "A String", # Etag of the response.
Dan O'Mearadd494642020-05-01 07:42:23 -07001040 "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
John Asmuth614db982014-04-24 15:46:26 -04001041 }</pre>
1042</div>
1043
1044<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001045 <code class="details" id="update">update(blogId, postId, body=None, x__xgafv=None, publish=None, fetchImages=None, revert=None, fetchBody=None, maxComments=None)</code>
1046 <pre>Updates a post by blog id and post id.
John Asmuth614db982014-04-24 15:46:26 -04001047
1048Args:
Dan O'Mearadd494642020-05-01 07:42:23 -07001049 blogId: string, A parameter (required)
1050 postId: string, A parameter (required)
1051 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -04001052 The object takes the form of:
1053
1054{
Dan O'Mearadd494642020-05-01 07:42:23 -07001055 "status": "A String", # Status of the post. Only set for admin-level requests.
1056 "blog": { # Data about the blog containing this Post.
1057 "id": "A String", # The identifier of the Blog that contains this Post.
1058 },
1059 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
John Asmuth614db982014-04-24 15:46:26 -04001060 "titleLink": "A String", # The title link URL, similar to atom's related link.
1061 "author": { # The author of this Post.
Dan O'Mearadd494642020-05-01 07:42:23 -07001062 "url": "A String", # The URL of the creator's Profile page.
1063 "image": { # The creator's avatar.
1064 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -04001065 },
1066 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -07001067 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -04001068 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001069 "title": "A String", # The title of the Post.
John Asmuth614db982014-04-24 15:46:26 -04001070 "replies": { # The container of comments on this Post.
1071 "totalItems": "A String", # The count of comments on this post.
1072 "items": [ # The List of Comments for this Post.
1073 {
Dan O'Mearadd494642020-05-01 07:42:23 -07001074 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -04001075 "inReplyTo": { # Data about the comment this is in reply to.
1076 "id": "A String", # The identified of the parent of this comment.
1077 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001078 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -04001079 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -07001080 "url": "A String", # The URL of the creator's Profile page.
1081 "image": { # The creator's avatar.
1082 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -04001083 },
1084 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -07001085 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -04001086 },
1087 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
1088 "blog": { # Data about the blog containing this comment.
1089 "id": "A String", # The identifier of the blog containing this comment.
1090 },
1091 "published": "A String", # RFC 3339 date-time when this comment was published.
1092 "post": { # Data about the post containing this comment.
1093 "id": "A String", # The identifier of the post containing this comment.
1094 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001095 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -04001096 "id": "A String", # The identifier for this resource.
1097 "selfLink": "A String", # The API REST URL to fetch this resource from.
1098 },
1099 ],
1100 "selfLink": "A String", # The URL of the comments on this post.
1101 },
Craig Citro065b5302014-08-14 00:47:23 -07001102 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -04001103 "labels": [ # The list of labels this Post was tagged with.
1104 "A String",
1105 ],
1106 "customMetaData": "A String", # The JSON meta-data for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -07001107 "kind": "A String", # The kind of this entity. Always blogger#post.
1108 "content": "A String", # The content of the Post. May contain HTML markup.
John Asmuth614db982014-04-24 15:46:26 -04001109 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -07001110 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -04001111 "location": { # The location for geotagged posts.
1112 "lat": 3.14, # Location's latitude.
1113 "lng": 3.14, # Location's longitude.
1114 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
1115 "name": "A String", # Location name.
1116 },
1117 "published": "A String", # RFC 3339 date-time when this Post was published.
1118 "images": [ # Display image for the Post.
1119 {
1120 "url": "A String",
1121 },
1122 ],
John Asmuth614db982014-04-24 15:46:26 -04001123 "id": "A String", # The identifier of this Post.
1124 "selfLink": "A String", # The API REST URL to fetch this resource from.
1125}
1126
Dan O'Mearadd494642020-05-01 07:42:23 -07001127 x__xgafv: string, V1 error format.
1128 Allowed values
1129 1 - v1 error format
1130 2 - v2 error format
1131 publish: boolean, A parameter
1132 fetchImages: boolean, A parameter
1133 revert: boolean, A parameter
1134 fetchBody: boolean, A parameter
1135 maxComments: integer, A parameter
John Asmuth614db982014-04-24 15:46:26 -04001136
1137Returns:
1138 An object of the form:
1139
1140 {
Dan O'Mearadd494642020-05-01 07:42:23 -07001141 "status": "A String", # Status of the post. Only set for admin-level requests.
1142 "blog": { # Data about the blog containing this Post.
1143 "id": "A String", # The identifier of the Blog that contains this Post.
1144 },
1145 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
John Asmuth614db982014-04-24 15:46:26 -04001146 "titleLink": "A String", # The title link URL, similar to atom's related link.
1147 "author": { # The author of this Post.
Dan O'Mearadd494642020-05-01 07:42:23 -07001148 "url": "A String", # The URL of the creator's Profile page.
1149 "image": { # The creator's avatar.
1150 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -04001151 },
1152 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -07001153 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -04001154 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001155 "title": "A String", # The title of the Post.
John Asmuth614db982014-04-24 15:46:26 -04001156 "replies": { # The container of comments on this Post.
1157 "totalItems": "A String", # The count of comments on this post.
1158 "items": [ # The List of Comments for this Post.
1159 {
Dan O'Mearadd494642020-05-01 07:42:23 -07001160 "status": "A String", # The status of the comment (only populated for admin users).
John Asmuth614db982014-04-24 15:46:26 -04001161 "inReplyTo": { # Data about the comment this is in reply to.
1162 "id": "A String", # The identified of the parent of this comment.
1163 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001164 "kind": "A String", # The kind of this entry. Always blogger#comment.
John Asmuth614db982014-04-24 15:46:26 -04001165 "author": { # The author of this Comment.
Dan O'Mearadd494642020-05-01 07:42:23 -07001166 "url": "A String", # The URL of the creator's Profile page.
1167 "image": { # The creator's avatar.
1168 "url": "A String", # The creator's avatar URL.
John Asmuth614db982014-04-24 15:46:26 -04001169 },
1170 "displayName": "A String", # The display name.
Dan O'Mearadd494642020-05-01 07:42:23 -07001171 "id": "A String", # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -04001172 },
1173 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
1174 "blog": { # Data about the blog containing this comment.
1175 "id": "A String", # The identifier of the blog containing this comment.
1176 },
1177 "published": "A String", # RFC 3339 date-time when this comment was published.
1178 "post": { # Data about the post containing this comment.
1179 "id": "A String", # The identifier of the post containing this comment.
1180 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001181 "content": "A String", # The actual content of the comment. May include HTML markup.
John Asmuth614db982014-04-24 15:46:26 -04001182 "id": "A String", # The identifier for this resource.
1183 "selfLink": "A String", # The API REST URL to fetch this resource from.
1184 },
1185 ],
1186 "selfLink": "A String", # The URL of the comments on this post.
1187 },
Craig Citro065b5302014-08-14 00:47:23 -07001188 "readerComments": "A String", # Comment control and display setting for readers of this post.
John Asmuth614db982014-04-24 15:46:26 -04001189 "labels": [ # The list of labels this Post was tagged with.
1190 "A String",
1191 ],
1192 "customMetaData": "A String", # The JSON meta-data for the Post.
Dan O'Mearadd494642020-05-01 07:42:23 -07001193 "kind": "A String", # The kind of this entity. Always blogger#post.
1194 "content": "A String", # The content of the Post. May contain HTML markup.
John Asmuth614db982014-04-24 15:46:26 -04001195 "url": "A String", # The URL where this Post is displayed.
Craig Citro065b5302014-08-14 00:47:23 -07001196 "etag": "A String", # Etag of the resource.
John Asmuth614db982014-04-24 15:46:26 -04001197 "location": { # The location for geotagged posts.
1198 "lat": 3.14, # Location's latitude.
1199 "lng": 3.14, # Location's longitude.
1200 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
1201 "name": "A String", # Location name.
1202 },
1203 "published": "A String", # RFC 3339 date-time when this Post was published.
1204 "images": [ # Display image for the Post.
1205 {
1206 "url": "A String",
1207 },
1208 ],
John Asmuth614db982014-04-24 15:46:26 -04001209 "id": "A String", # The identifier of this Post.
1210 "selfLink": "A String", # The API REST URL to fetch this resource from.
1211 }</pre>
1212</div>
1213
1214</body></html>