Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / df61397973d36909a46fc4c3bf0e006dbb69f79a / . / docs / dyn / blogger_v2.posts.html
blob: fabb3de683056329391f058618c846d2696c1cc2 [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
75<h1><a href="blogger_v2.html">Blogger API</a> . <a href="blogger_v2.posts.html">posts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(blogId, postId)</a></code></p>
79<p class="firstline">Get a post by id.</p>
80<p class="toc_element">
81 <code><a href="#list">list(blogId, startDate=None, pageToken=None, maxResults=None, fetchBodies=None)</a></code></p>
82<p class="firstline">Retrieves a list of posts, possibly filtered.</p>
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">
88 <code class="details" id="get">get(blogId, postId)</code>
89 <pre>Get a post by id.
90
91Args:
92 blogId: string, ID of the blog to fetch the post from. (required)
93 postId: string, The ID of the post (required)
94
95Returns:
96 An object of the form:
97
98 {
99 "content": "A String", # The content of the Post. May contain HTML markup.
100 "kind": "blogger#post", # The kind of this entity. Always blogger#post
101 "author": { # The author of this Post.
102 "url": "A String", # The URL of the Post creator's Profile page.
103 "image": { # The Post author's avatar.
104 "url": "A String", # The Post author's avatar URL.
105 },
106 "displayName": "A String", # The display name.
107 "id": "A String", # The identifier of the Post creator.
108 },
109 "replies": { # The container of comments on this Post.
110 "totalItems": "A String", # The count of comments on this post.
111 "selfLink": "A String", # The URL of the comments on this post.
112 },
113 "labels": [ # The list of labels this Post was tagged with.
114 "A String",
115 ],
116 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
117 "blog": { # Data about the blog containing this Post.
118 "id": "A String", # The identifier of the Blog that contains this Post.
119 },
120 "url": "A String", # The URL where this Post is displayed.
121 "published": "A String", # RFC 3339 date-time when this Post was published.
122 "title": "A String", # The title of the Post.
123 "id": "A String", # The identifier of this Post.
124 "selfLink": "A String", # The API REST URL to fetch this resource from.
125 }</pre>
126</div>
127
128<div class="method">
129 <code class="details" id="list">list(blogId, startDate=None, pageToken=None, maxResults=None, fetchBodies=None)</code>
130 <pre>Retrieves a list of posts, possibly filtered.
131
132Args:
133 blogId: string, ID of the blog to fetch posts from. (required)
134 startDate: string, Earliest post date to fetch, a date-time with RFC 3339 formatting.
135 pageToken: string, Continuation token if the request is paged.
136 maxResults: integer, Maximum number of posts to fetch.
137 fetchBodies: boolean, Whether the body content of posts is included.
138
139Returns:
140 An object of the form:
141
142 {
143 "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
144 "items": [ # The list of Posts for this Blog.
145 {
146 "content": "A String", # The content of the Post. May contain HTML markup.
147 "kind": "blogger#post", # The kind of this entity. Always blogger#post
148 "author": { # The author of this Post.
149 "url": "A String", # The URL of the Post creator's Profile page.
150 "image": { # The Post author's avatar.
151 "url": "A String", # The Post author's avatar URL.
152 },
153 "displayName": "A String", # The display name.
154 "id": "A String", # The identifier of the Post creator.
155 },
156 "replies": { # The container of comments on this Post.
157 "totalItems": "A String", # The count of comments on this post.
158 "selfLink": "A String", # The URL of the comments on this post.
159 },
160 "labels": [ # The list of labels this Post was tagged with.
161 "A String",
162 ],
163 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
164 "blog": { # Data about the blog containing this Post.
165 "id": "A String", # The identifier of the Blog that contains this Post.
166 },
167 "url": "A String", # The URL where this Post is displayed.
168 "published": "A String", # RFC 3339 date-time when this Post was published.
169 "title": "A String", # The title of the Post.
170 "id": "A String", # The identifier of this Post.
171 "selfLink": "A String", # The API REST URL to fetch this resource from.
172 },
173 ],
174 "kind": "blogger#postList", # The kind of this entity. Always blogger#postList
175 "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
176 }</pre>
177</div>
178
179<div class="method">
180 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
181 <pre>Retrieves the next page of results.
182
183Args:
184 previous_request: The request for the previous page. (required)
185 previous_response: The response from the request for the previous page. (required)
186
187Returns:
188 A request object that you can call 'execute()' on to request the next
189 page. Returns None if there are no more items in the collection.
190 </pre>
191</div>
192
193</body></html>