Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / blogger_v2.posts.html
blob: 84e8b37fc51fc8b028b039d77280a7e0f3a16487 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1<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 -0700[diff] [blame^]75<h1><a href="blogger_v2.html">Blogger API v3</a> . <a href="blogger_v2.posts.html">posts</a></h1>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#get">get(blogId, postId, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a post by blog id and post id</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#list">list(blogId, startDate=None, maxResults=None, pageToken=None, x__xgafv=None, fetchBodies=None)</a></code></p>
82<p class="firstline">Lists posts.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]88 <code class="details" id="get">get(blogId, postId, x__xgafv=None)</code>
89 <pre>Gets a post by blog id and post id
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]90
91Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]92 blogId: string, A parameter (required)
93 postId: string, A parameter (required)
94 x__xgafv: string, V1 error format.
95 Allowed values
96 1 - v1 error format
97 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]98
99Returns:
100 An object of the form:
101
102 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 "status": "A String", # Status of the post. Only set for admin-level requests.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]104 "blog": { # Data about the blog containing this Post.
105 "id": "A String", # The identifier of the Blog that contains this Post.
106 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]107 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
108 "titleLink": "A String", # The title link URL, similar to atom's related link.
109 "author": { # The author of this Post.
110 "url": "A String", # The URL of the creator's Profile page.
111 "image": { # The creator's avatar.
112 "url": "A String", # The creator's avatar URL.
113 },
114 "displayName": "A String", # The display name.
115 "id": "A String", # The identifier of the creator.
116 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]117 "url": "A String", # The URL where this Post is displayed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118 "readerComments": "A String", # Comment control and display setting for readers of this post.
119 "labels": [ # The list of labels this Post was tagged with.
120 "A String",
121 ],
122 "replies": { # The container of comments on this Post.
123 "totalItems": "A String", # The count of comments on this post.
124 "items": [ # The List of Comments for this Post.
125 {
126 "status": "A String", # The status of the comment (only populated for admin users).
127 "inReplyTo": { # Data about the comment this is in reply to.
128 "id": "A String", # The identified of the parent of this comment.
129 },
130 "kind": "A String", # The kind of this entry. Always blogger#comment.
131 "author": { # The author of this Comment.
132 "url": "A String", # The URL of the creator's Profile page.
133 "image": { # The creator's avatar.
134 "url": "A String", # The creator's avatar URL.
135 },
136 "displayName": "A String", # The display name.
137 "id": "A String", # The identifier of the creator.
138 },
139 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
140 "blog": { # Data about the blog containing this comment.
141 "id": "A String", # The identifier of the blog containing this comment.
142 },
143 "published": "A String", # RFC 3339 date-time when this comment was published.
144 "post": { # Data about the post containing this comment.
145 "id": "A String", # The identifier of the post containing this comment.
146 },
147 "content": "A String", # The actual content of the comment. May include HTML markup.
148 "id": "A String", # The identifier for this resource.
149 "selfLink": "A String", # The API REST URL to fetch this resource from.
150 },
151 ],
152 "selfLink": "A String", # The URL of the comments on this post.
153 },
154 "customMetaData": "A String", # The JSON meta-data for the Post.
155 "kind": "A String", # The kind of this entity. Always blogger#post.
156 "content": "A String", # The content of the Post. May contain HTML markup.
157 "etag": "A String", # Etag of the resource.
158 "location": { # The location for geotagged posts.
159 "lat": 3.14, # Location's latitude.
160 "lng": 3.14, # Location's longitude.
161 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
162 "name": "A String", # Location name.
163 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]164 "published": "A String", # RFC 3339 date-time when this Post was published.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]165 "images": [ # Display image for the Post.
166 {
167 "url": "A String",
168 },
169 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]170 "title": "A String", # The title of the Post.
171 "id": "A String", # The identifier of this Post.
172 "selfLink": "A String", # The API REST URL to fetch this resource from.
173 }</pre>
174</div>
175
176<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]177 <code class="details" id="list">list(blogId, startDate=None, maxResults=None, pageToken=None, x__xgafv=None, fetchBodies=None)</code>
178 <pre>Lists posts.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]179
180Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]181 blogId: string, A parameter (required)
182 startDate: string, A parameter
183 maxResults: integer, A parameter
184 pageToken: string, A parameter
185 x__xgafv: string, V1 error format.
186 Allowed values
187 1 - v1 error format
188 2 - v2 error format
189 fetchBodies: boolean, A parameter
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]190
191Returns:
192 An object of the form:
193
194 {
195 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
196 "items": [ # The list of Posts for this Blog.
197 {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]198 "status": "A String", # Status of the post. Only set for admin-level requests.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]199 "blog": { # Data about the blog containing this Post.
200 "id": "A String", # The identifier of the Blog that contains this Post.
201 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]202 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
203 "titleLink": "A String", # The title link URL, similar to atom's related link.
204 "author": { # The author of this Post.
205 "url": "A String", # The URL of the creator's Profile page.
206 "image": { # The creator's avatar.
207 "url": "A String", # The creator's avatar URL.
208 },
209 "displayName": "A String", # The display name.
210 "id": "A String", # The identifier of the creator.
211 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]212 "url": "A String", # The URL where this Post is displayed.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]213 "readerComments": "A String", # Comment control and display setting for readers of this post.
214 "labels": [ # The list of labels this Post was tagged with.
215 "A String",
216 ],
217 "replies": { # The container of comments on this Post.
218 "totalItems": "A String", # The count of comments on this post.
219 "items": [ # The List of Comments for this Post.
220 {
221 "status": "A String", # The status of the comment (only populated for admin users).
222 "inReplyTo": { # Data about the comment this is in reply to.
223 "id": "A String", # The identified of the parent of this comment.
224 },
225 "kind": "A String", # The kind of this entry. Always blogger#comment.
226 "author": { # The author of this Comment.
227 "url": "A String", # The URL of the creator's Profile page.
228 "image": { # The creator's avatar.
229 "url": "A String", # The creator's avatar URL.
230 },
231 "displayName": "A String", # The display name.
232 "id": "A String", # The identifier of the creator.
233 },
234 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
235 "blog": { # Data about the blog containing this comment.
236 "id": "A String", # The identifier of the blog containing this comment.
237 },
238 "published": "A String", # RFC 3339 date-time when this comment was published.
239 "post": { # Data about the post containing this comment.
240 "id": "A String", # The identifier of the post containing this comment.
241 },
242 "content": "A String", # The actual content of the comment. May include HTML markup.
243 "id": "A String", # The identifier for this resource.
244 "selfLink": "A String", # The API REST URL to fetch this resource from.
245 },
246 ],
247 "selfLink": "A String", # The URL of the comments on this post.
248 },
249 "customMetaData": "A String", # The JSON meta-data for the Post.
250 "kind": "A String", # The kind of this entity. Always blogger#post.
251 "content": "A String", # The content of the Post. May contain HTML markup.
252 "etag": "A String", # Etag of the resource.
253 "location": { # The location for geotagged posts.
254 "lat": 3.14, # Location's latitude.
255 "lng": 3.14, # Location's longitude.
256 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
257 "name": "A String", # Location name.
258 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]259 "published": "A String", # RFC 3339 date-time when this Post was published.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]260 "images": [ # Display image for the Post.
261 {
262 "url": "A String",
263 },
264 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]265 "title": "A String", # The title of the Post.
266 "id": "A String", # The identifier of this Post.
267 "selfLink": "A String", # The API REST URL to fetch this resource from.
268 },
269 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]270 "kind": "A String", # The kind of this entity. Always blogger#postList.
271 "etag": "A String", # Etag of the response.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]272 "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
273 }</pre>
274</div>
275
276<div class="method">
277 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
278 <pre>Retrieves the next page of results.
279
280Args:
281 previous_request: The request for the previous page. (required)
282 previous_response: The response from the request for the previous page. (required)
283
284Returns:
285 A request object that you can call 'execute()' on to request the next
286 page. Returns None if there are no more items in the collection.
287 </pre>
288</div>
289
290</body></html>