John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 | |
| 85 | Args: |
| 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 | |
| 90 | Returns: |
| 91 | An object of the form: |
| 92 | |
| 93 | { |
| 94 | "blog": { # The Blog resource. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame^] | 95 | "status": "A String", # The status of the blog. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 96 | "kind": "blogger#blog", # The kind of this entry. Always blogger#blog |
| 97 | "description": "A String", # The description of this blog. This is displayed underneath the title. |
| 98 | "locale": { # The locale this Blog is set to. |
| 99 | "country": "A String", # The country this blog's locale is set to. |
| 100 | "variant": "A String", # The language variant this blog is authored in. |
| 101 | "language": "A String", # The language this blog is authored in. |
| 102 | }, |
| 103 | "posts": { # The container of posts in this blog. |
| 104 | "totalItems": 42, # The count of posts in this blog. |
| 105 | "items": [ # The List of Posts for this Blog. |
| 106 | { |
| 107 | "status": "A String", # Status of the post. Only set for admin-level requests |
| 108 | "content": "A String", # The content of the Post. May contain HTML markup. |
| 109 | "kind": "blogger#post", # The kind of this entity. Always blogger#post |
| 110 | "titleLink": "A String", # The title link URL, similar to atom's related link. |
| 111 | "author": { # The author of this Post. |
| 112 | "url": "A String", # The URL of the Post creator's Profile page. |
| 113 | "image": { # The Post author's avatar. |
| 114 | "url": "A String", # The Post author's avatar URL. |
| 115 | }, |
| 116 | "displayName": "A String", # The display name. |
| 117 | "id": "A String", # The identifier of the Post creator. |
| 118 | }, |
| 119 | "replies": { # The container of comments on this Post. |
| 120 | "totalItems": "A String", # The count of comments on this post. |
| 121 | "items": [ # The List of Comments for this Post. |
| 122 | { |
| 123 | "status": "A String", # The status of the comment (only populated for admin users) |
| 124 | "content": "A String", # The actual content of the comment. May include HTML markup. |
| 125 | "kind": "blogger#comment", # The kind of this entry. Always blogger#comment |
| 126 | "inReplyTo": { # Data about the comment this is in reply to. |
| 127 | "id": "A String", # The identified of the parent of this comment. |
| 128 | }, |
| 129 | "author": { # The author of this Comment. |
| 130 | "url": "A String", # The URL of the Comment creator's Profile page. |
| 131 | "image": { # The comment creator's avatar. |
| 132 | "url": "A String", # The comment creator's avatar URL. |
| 133 | }, |
| 134 | "displayName": "A String", # The display name. |
| 135 | "id": "A String", # The identifier of the Comment creator. |
| 136 | }, |
| 137 | "updated": "A String", # RFC 3339 date-time when this comment was last updated. |
| 138 | "blog": { # Data about the blog containing this comment. |
| 139 | "id": "A String", # The identifier of the blog containing this comment. |
| 140 | }, |
| 141 | "published": "A String", # RFC 3339 date-time when this comment was published. |
| 142 | "post": { # Data about the post containing this comment. |
| 143 | "id": "A String", # The identifier of the post containing this comment. |
| 144 | }, |
| 145 | "id": "A String", # The identifier for this resource. |
| 146 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 147 | }, |
| 148 | ], |
| 149 | "selfLink": "A String", # The URL of the comments on this post. |
| 150 | }, |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame^] | 151 | "readerComments": "A String", # Comment control and display setting for readers of this post. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 152 | "labels": [ # The list of labels this Post was tagged with. |
| 153 | "A String", |
| 154 | ], |
| 155 | "customMetaData": "A String", # The JSON meta-data for the Post. |
| 156 | "updated": "A String", # RFC 3339 date-time when this Post was last updated. |
| 157 | "blog": { # Data about the blog containing this Post. |
| 158 | "id": "A String", # The identifier of the Blog that contains this Post. |
| 159 | }, |
| 160 | "url": "A String", # The URL where this Post is displayed. |
Craig Citro | 065b530 | 2014-08-14 00:47:23 -0700 | [diff] [blame^] | 161 | "etag": "A String", # Etag of the resource. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 162 | "location": { # The location for geotagged posts. |
| 163 | "lat": 3.14, # Location's latitude. |
| 164 | "lng": 3.14, # Location's longitude. |
| 165 | "span": "A String", # Location's viewport span. Can be used when rendering a map preview. |
| 166 | "name": "A String", # Location name. |
| 167 | }, |
| 168 | "published": "A String", # RFC 3339 date-time when this Post was published. |
| 169 | "images": [ # Display image for the Post. |
| 170 | { |
| 171 | "url": "A String", |
| 172 | }, |
| 173 | ], |
| 174 | "title": "A String", # The title of the Post. |
| 175 | "id": "A String", # The identifier of this Post. |
| 176 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 177 | }, |
| 178 | ], |
| 179 | "selfLink": "A String", # The URL of the container for posts in this blog. |
| 180 | }, |
| 181 | "customMetaData": "A String", # The JSON custom meta-data for the Blog |
| 182 | "updated": "A String", # RFC 3339 date-time when this blog was last updated. |
| 183 | "pages": { # The container of pages in this blog. |
| 184 | "totalItems": 42, # The count of pages in this blog. |
| 185 | "selfLink": "A String", # The URL of the container for pages in this blog. |
| 186 | }, |
| 187 | "url": "A String", # The URL where this blog is published. |
| 188 | "published": "A String", # RFC 3339 date-time when this blog was published. |
| 189 | "id": "A String", # The identifier for this resource. |
| 190 | "selfLink": "A String", # The API REST URL to fetch this resource from. |
| 191 | "name": "A String", # The name of this blog. This is displayed as the title. |
| 192 | }, |
| 193 | "kind": "blogger#blogUserInfo", # The kind of this entity. Always blogger#blogUserInfo |
| 194 | "blog_user_info": { # Information about a User for the Blog. |
| 195 | "hasAdminAccess": True or False, # True if the user has Admin level access to the blog. |
| 196 | "kind": "blogger#blogPerUserInfo", # The kind of this entity. Always blogger#blogPerUserInfo |
| 197 | "userId": "A String", # ID of the User |
| 198 | "role": "A String", # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER). |
| 199 | "photosAlbumKey": "A String", # The Photo Album Key for the user when adding photos to the blog |
| 200 | "blogId": "A String", # ID of the Blog resource |
| 201 | }, |
| 202 | }</pre> |
| 203 | </div> |
| 204 | |
| 205 | </body></html> |