blob: edbbc31d4fabd65761bec31f188355678c6d83c5 [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.blogUserInfos.html">blogUserInfos</a></h1>
John Asmuth614db982014-04-24 15:46:26 -040076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070081 <code><a href="#get">get(userId, blogId, maxPosts=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070082<p class="firstline">Gets one blog and user info pair by blog id and user id.</p>
John Asmuth614db982014-04-24 15:46:26 -040083<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -070090 <code class="details" id="get">get(userId, blogId, maxPosts=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -070091 <pre>Gets one blog and user info pair by blog id and user id.
John Asmuth614db982014-04-24 15:46:26 -040092
93Args:
Dan O'Mearadd494642020-05-01 07:42:23 -070094 userId: string, A parameter (required)
95 blogId: string, A parameter (required)
Bu Sun Kim65020912020-05-20 12:08:20 -070096 maxPosts: integer, A parameter
Dan O'Mearadd494642020-05-01 07:42:23 -070097 x__xgafv: string, V1 error format.
98 Allowed values
99 1 - v1 error format
100 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400101
102Returns:
103 An object of the form:
104
105 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700106 &quot;blog&quot;: { # The Blog resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700107 &quot;posts&quot;: { # The container of posts in this blog.
Bu Sun Kim65020912020-05-20 12:08:20 -0700108 &quot;items&quot;: [ # The List of Posts for this Blog.
John Asmuth614db982014-04-24 15:46:26 -0400109 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700110 &quot;content&quot;: &quot;A String&quot;, # The content of the Post. May contain HTML markup.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700111 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700112 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#post.
Bu Sun Kim65020912020-05-20 12:08:20 -0700113 &quot;author&quot;: { # The author of this Post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700114 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700115 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
Bu Sun Kim65020912020-05-20 12:08:20 -0700116 &quot;image&quot;: { # The creator&#x27;s avatar.
117 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
118 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700119 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
John Asmuth614db982014-04-24 15:46:26 -0400120 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700121 &quot;title&quot;: &quot;A String&quot;, # The title of the Post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700122 &quot;labels&quot;: [ # The list of labels this Post was tagged with.
123 &quot;A String&quot;,
124 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700125 &quot;titleLink&quot;: &quot;A String&quot;, # The title link URL, similar to atom&#x27;s related link.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700126 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was last updated.
127 &quot;location&quot;: { # The location for geotagged posts.
128 &quot;lat&quot;: 3.14, # Location&#x27;s latitude.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700129 &quot;lng&quot;: 3.14, # Location&#x27;s longitude.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700130 &quot;span&quot;: &quot;A String&quot;, # Location&#x27;s viewport span. Can be used when rendering a map preview.
131 &quot;name&quot;: &quot;A String&quot;, # Location name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700132 },
133 &quot;customMetaData&quot;: &quot;A String&quot;, # The JSON meta-data for the Post.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700134 &quot;url&quot;: &quot;A String&quot;, # The URL where this Post is displayed.
135 &quot;readerComments&quot;: &quot;A String&quot;, # Comment control and display setting for readers of this post.
136 &quot;status&quot;: &quot;A String&quot;, # Status of the post. Only set for admin-level requests.
137 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this Post was published.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700138 &quot;blog&quot;: { # Data about the blog containing this Post.
139 &quot;id&quot;: &quot;A String&quot;, # The identifier of the Blog that contains this Post.
140 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700141 &quot;etag&quot;: &quot;A String&quot;, # Etag of the resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700142 &quot;replies&quot;: { # The container of comments on this Post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700143 &quot;items&quot;: [ # The List of Comments for this Post.
144 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700145 &quot;author&quot;: { # The author of this Comment.
146 &quot;displayName&quot;: &quot;A String&quot;, # The display name.
147 &quot;image&quot;: { # The creator&#x27;s avatar.
148 &quot;url&quot;: &quot;A String&quot;, # The creator&#x27;s avatar URL.
149 },
150 &quot;id&quot;: &quot;A String&quot;, # The identifier of the creator.
151 &quot;url&quot;: &quot;A String&quot;, # The URL of the creator&#x27;s Profile page.
152 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700153 &quot;inReplyTo&quot;: { # Data about the comment this is in reply to.
154 &quot;id&quot;: &quot;A String&quot;, # The identified of the parent of this comment.
155 },
156 &quot;content&quot;: &quot;A String&quot;, # The actual content of the comment. May include HTML markup.
157 &quot;post&quot;: { # Data about the post containing this comment.
158 &quot;id&quot;: &quot;A String&quot;, # The identifier of the post containing this comment.
159 },
160 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#comment.
161 &quot;blog&quot;: { # Data about the blog containing this comment.
162 &quot;id&quot;: &quot;A String&quot;, # The identifier of the blog containing this comment.
163 },
164 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
165 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was published.
166 &quot;status&quot;: &quot;A String&quot;, # The status of the comment (only populated for admin users).
167 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
168 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this comment was last updated.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700169 },
170 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700171 &quot;totalItems&quot;: &quot;A String&quot;, # The count of comments on this post.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700172 &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the comments on this post.
173 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700174 &quot;images&quot;: [ # Display image for the Post.
175 {
176 &quot;url&quot;: &quot;A String&quot;,
177 },
178 ],
179 &quot;id&quot;: &quot;A String&quot;, # The identifier of this Post.
John Asmuth614db982014-04-24 15:46:26 -0400180 },
181 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700182 &quot;totalItems&quot;: 42, # The count of posts in this blog.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700183 &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the container for posts in this blog.
John Asmuth614db982014-04-24 15:46:26 -0400184 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700185 &quot;updated&quot;: &quot;A String&quot;, # RFC 3339 date-time when this blog was last updated.
186 &quot;selfLink&quot;: &quot;A String&quot;, # The API REST URL to fetch this resource from.
Bu Sun Kim65020912020-05-20 12:08:20 -0700187 &quot;url&quot;: &quot;A String&quot;, # The URL where this blog is published.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700188 &quot;customMetaData&quot;: &quot;A String&quot;, # The JSON custom meta-data for the Blog.
189 &quot;description&quot;: &quot;A String&quot;, # The description of this blog. This is displayed underneath the title.
190 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entry. Always blogger#blog.
191 &quot;published&quot;: &quot;A String&quot;, # RFC 3339 date-time when this blog was published.
192 &quot;pages&quot;: { # The container of pages in this blog.
193 &quot;totalItems&quot;: 42, # The count of pages in this blog.
194 &quot;selfLink&quot;: &quot;A String&quot;, # The URL of the container for pages in this blog.
195 },
196 &quot;id&quot;: &quot;A String&quot;, # The identifier for this resource.
197 &quot;name&quot;: &quot;A String&quot;, # The name of this blog. This is displayed as the title.
198 &quot;locale&quot;: { # The locale this Blog is set to.
199 &quot;country&quot;: &quot;A String&quot;, # The country this blog&#x27;s locale is set to.
200 &quot;language&quot;: &quot;A String&quot;, # The language this blog is authored in.
201 &quot;variant&quot;: &quot;A String&quot;, # The language variant this blog is authored in.
202 },
203 &quot;status&quot;: &quot;A String&quot;, # The status of the blog.
John Asmuth614db982014-04-24 15:46:26 -0400204 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700205 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#blogUserInfo.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700206 &quot;blog_user_info&quot;: { # Information about a User for the Blog.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700207 &quot;hasAdminAccess&quot;: True or False, # True if the user has Admin level access to the blog.
208 &quot;role&quot;: &quot;A String&quot;, # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).
209 &quot;userId&quot;: &quot;A String&quot;, # ID of the User.
210 &quot;photosAlbumKey&quot;: &quot;A String&quot;, # The Photo Album Key for the user when adding photos to the blog.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700211 &quot;blogId&quot;: &quot;A String&quot;, # ID of the Blog resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700212 &quot;kind&quot;: &quot;A String&quot;, # The kind of this entity. Always blogger#blogPerUserInfo.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700213 },
John Asmuth614db982014-04-24 15:46:26 -0400214 }</pre>
215</div>
216
217</body></html>