Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / blogger_v3.blogUserInfos.html
blob: 155f184d34da9062c275506722fbc40191678ebd [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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_v3.html">Blogger API</a> . <a href="blogger_v3.blogUserInfos.html">blogUserInfos</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(userId, blogId, maxPosts=None)</a></code></p>
79<p class="firstline">Gets one blog and user info pair by blogId and userId.</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="get">get(userId, blogId, maxPosts=None)</code>
83 <pre>Gets one blog and user info pair by blogId and userId.
84
85Args:
86 userId: string, ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)
87 blogId: string, The ID of the blog to get. (required)
88 maxPosts: integer, Maximum number of posts to pull back with the blog.
89
90Returns:
91 An object of the form:
92
93 {
94 "blog": { # The Blog resource.
95 "kind": "blogger#blog", # The kind of this entry. Always blogger#blog
96 "description": "A String", # The description of this blog. This is displayed underneath the title.
97 "locale": { # The locale this Blog is set to.
98 "country": "A String", # The country this blog's locale is set to.
99 "variant": "A String", # The language variant this blog is authored in.
100 "language": "A String", # The language this blog is authored in.
101 },
102 "posts": { # The container of posts in this blog.
103 "totalItems": 42, # The count of posts in this blog.
104 "items": [ # The List of Posts for this Blog.
105 {
106 "status": "A String", # Status of the post. Only set for admin-level requests
107 "content": "A String", # The content of the Post. May contain HTML markup.
108 "kind": "blogger#post", # The kind of this entity. Always blogger#post
109 "titleLink": "A String", # The title link URL, similar to atom's related link.
110 "author": { # The author of this Post.
111 "url": "A String", # The URL of the Post creator's Profile page.
112 "image": { # The Post author's avatar.
113 "url": "A String", # The Post author's avatar URL.
114 },
115 "displayName": "A String", # The display name.
116 "id": "A String", # The identifier of the Post creator.
117 },
118 "replies": { # The container of comments on this Post.
119 "totalItems": "A String", # The count of comments on this post.
120 "items": [ # The List of Comments for this Post.
121 {
122 "status": "A String", # The status of the comment (only populated for admin users)
123 "content": "A String", # The actual content of the comment. May include HTML markup.
124 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
125 "inReplyTo": { # Data about the comment this is in reply to.
126 "id": "A String", # The identified of the parent of this comment.
127 },
128 "author": { # The author of this Comment.
129 "url": "A String", # The URL of the Comment creator's Profile page.
130 "image": { # The comment creator's avatar.
131 "url": "A String", # The comment creator's avatar URL.
132 },
133 "displayName": "A String", # The display name.
134 "id": "A String", # The identifier of the Comment creator.
135 },
136 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
137 "blog": { # Data about the blog containing this comment.
138 "id": "A String", # The identifier of the blog containing this comment.
139 },
140 "published": "A String", # RFC 3339 date-time when this comment was published.
141 "post": { # Data about the post containing this comment.
142 "id": "A String", # The identifier of the post containing this comment.
143 },
144 "id": "A String", # The identifier for this resource.
145 "selfLink": "A String", # The API REST URL to fetch this resource from.
146 },
147 ],
148 "selfLink": "A String", # The URL of the comments on this post.
149 },
150 "labels": [ # The list of labels this Post was tagged with.
151 "A String",
152 ],
153 "customMetaData": "A String", # The JSON meta-data for the Post.
154 "updated": "A String", # RFC 3339 date-time when this Post was last updated.
155 "blog": { # Data about the blog containing this Post.
156 "id": "A String", # The identifier of the Blog that contains this Post.
157 },
158 "url": "A String", # The URL where this Post is displayed.
159 "location": { # The location for geotagged posts.
160 "lat": 3.14, # Location's latitude.
161 "lng": 3.14, # Location's longitude.
162 "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
163 "name": "A String", # Location name.
164 },
165 "published": "A String", # RFC 3339 date-time when this Post was published.
166 "images": [ # Display image for the Post.
167 {
168 "url": "A String",
169 },
170 ],
171 "title": "A String", # The title of the Post.
172 "id": "A String", # The identifier of this Post.
173 "selfLink": "A String", # The API REST URL to fetch this resource from.
174 },
175 ],
176 "selfLink": "A String", # The URL of the container for posts in this blog.
177 },
178 "customMetaData": "A String", # The JSON custom meta-data for the Blog
179 "updated": "A String", # RFC 3339 date-time when this blog was last updated.
180 "pages": { # The container of pages in this blog.
181 "totalItems": 42, # The count of pages in this blog.
182 "selfLink": "A String", # The URL of the container for pages in this blog.
183 },
184 "url": "A String", # The URL where this blog is published.
185 "published": "A String", # RFC 3339 date-time when this blog was published.
186 "id": "A String", # The identifier for this resource.
187 "selfLink": "A String", # The API REST URL to fetch this resource from.
188 "name": "A String", # The name of this blog. This is displayed as the title.
189 },
190 "kind": "blogger#blogUserInfo", # The kind of this entity. Always blogger#blogUserInfo
191 "blog_user_info": { # Information about a User for the Blog.
192 "hasAdminAccess": True or False, # True if the user has Admin level access to the blog.
193 "kind": "blogger#blogPerUserInfo", # The kind of this entity. Always blogger#blogPerUserInfo
194 "userId": "A String", # ID of the User
195 "role": "A String", # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).
196 "photosAlbumKey": "A String", # The Photo Album Key for the user when adding photos to the blog
197 "blogId": "A String", # ID of the Blog resource
198 },
199 }</pre>
200</div>
201
202</body></html>