| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="blogger_v3.html">Blogger API v3</a> . <a href="blogger_v3.blogs.html">blogs</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#get">get(blogId, maxPosts=None, view=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a blog by id.</p> |
| <p class="toc_element"> |
| <code><a href="#getByUrl">getByUrl(url, view=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a blog by url.</p> |
| <p class="toc_element"> |
| <code><a href="#listByUser">listByUser(userId, role=None, status=None, view=None, fetchUserInfo=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists blogs by user.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="get">get(blogId, maxPosts=None, view=None, x__xgafv=None)</code> |
| <pre>Gets a blog by id. |
| |
| Args: |
| blogId: string, A parameter (required) |
| maxPosts: integer, A parameter |
| view: string, A parameter |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "description": "A String", # The description of this blog. This is displayed underneath the title. |
| "id": "A String", # The identifier for this resource. |
| "selfLink": "A String", # The API REST URL to fetch this resource from. |
| "name": "A String", # The name of this blog. This is displayed as the title. |
| "customMetaData": "A String", # The JSON custom meta-data for the Blog. |
| "status": "A String", # The status of the blog. |
| "pages": { # The container of pages in this blog. |
| "totalItems": 42, # The count of pages in this blog. |
| "selfLink": "A String", # The URL of the container for pages in this blog. |
| }, |
| "kind": "A String", # The kind of this entry. Always blogger#blog. |
| "locale": { # The locale this Blog is set to. |
| "country": "A String", # The country this blog's locale is set to. |
| "language": "A String", # The language this blog is authored in. |
| "variant": "A String", # The language variant this blog is authored in. |
| }, |
| "updated": "A String", # RFC 3339 date-time when this blog was last updated. |
| "posts": { # The container of posts in this blog. |
| "selfLink": "A String", # The URL of the container for posts in this blog. |
| "items": [ # The List of Posts for this Blog. |
| { |
| "selfLink": "A String", # The API REST URL to fetch this resource from. |
| "author": { # The author of this Post. |
| "displayName": "A String", # The display name. |
| "url": "A String", # The URL of the creator's Profile page. |
| "image": { # The creator's avatar. |
| "url": "A String", # The creator's avatar URL. |
| }, |
| "id": "A String", # The identifier of the creator. |
| }, |
| "etag": "A String", # Etag of the resource. |
| "published": "A String", # RFC 3339 date-time when this Post was published. |
| "images": [ # Display image for the Post. |
| { |
| "url": "A String", |
| }, |
| ], |
| "labels": [ # The list of labels this Post was tagged with. |
| "A String", |
| ], |
| "updated": "A String", # RFC 3339 date-time when this Post was last updated. |
| "location": { # The location for geotagged posts. |
| "lat": 3.14, # Location's latitude. |
| "span": "A String", # Location's viewport span. Can be used when rendering a map preview. |
| "name": "A String", # Location name. |
| "lng": 3.14, # Location's longitude. |
| }, |
| "customMetaData": "A String", # The JSON meta-data for the Post. |
| "id": "A String", # The identifier of this Post. |
| "blog": { # Data about the blog containing this Post. |
| "id": "A String", # The identifier of the Blog that contains this Post. |
| }, |
| "kind": "A String", # The kind of this entity. Always blogger#post. |
| "readerComments": "A String", # Comment control and display setting for readers of this post. |
| "status": "A String", # Status of the post. Only set for admin-level requests. |
| "replies": { # The container of comments on this Post. |
| "totalItems": "A String", # The count of comments on this post. |
| "items": [ # The List of Comments for this Post. |
| { |
| "content": "A String", # The actual content of the comment. May include HTML markup. |
| "id": "A String", # The identifier for this resource. |
| "post": { # Data about the post containing this comment. |
| "id": "A String", # The identifier of the post containing this comment. |
| }, |
| "blog": { # Data about the blog containing this comment. |
| "id": "A String", # The identifier of the blog containing this comment. |
| }, |
| "status": "A String", # The status of the comment (only populated for admin users). |
| "selfLink": "A String", # The API REST URL to fetch this resource from. |
| "updated": "A String", # RFC 3339 date-time when this comment was last updated. |
| "kind": "A String", # The kind of this entry. Always blogger#comment. |
| "inReplyTo": { # Data about the comment this is in reply to. |
| "id": "A String", # The identified of the parent of this comment. |
| }, |
| "published": "A String", # RFC 3339 date-time when this comment was published. |
| "author": { # The author of this Comment. |
| "displayName": "A String", # The display name. |
| "image": { # The creator's avatar. |
| "url": "A String", # The creator's avatar URL. |
| }, |
| "id": "A String", # The identifier of the creator. |
| "url": "A String", # The URL of the creator's Profile page. |
| }, |
| }, |
| ], |
| "selfLink": "A String", # The URL of the comments on this post. |
| }, |
| "title": "A String", # The title of the Post. |
| "url": "A String", # The URL where this Post is displayed. |
| "content": "A String", # The content of the Post. May contain HTML markup. |
| "titleLink": "A String", # The title link URL, similar to atom's related link. |
| }, |
| ], |
| "totalItems": 42, # The count of posts in this blog. |
| }, |
| "published": "A String", # RFC 3339 date-time when this blog was published. |
| "url": "A String", # The URL where this blog is published. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getByUrl">getByUrl(url, view=None, x__xgafv=None)</code> |
| <pre>Gets a blog by url. |
| |
| Args: |
| url: string, A parameter (required) |
| view: string, A parameter |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "description": "A String", # The description of this blog. This is displayed underneath the title. |
| "id": "A String", # The identifier for this resource. |
| "selfLink": "A String", # The API REST URL to fetch this resource from. |
| "name": "A String", # The name of this blog. This is displayed as the title. |
| "customMetaData": "A String", # The JSON custom meta-data for the Blog. |
| "status": "A String", # The status of the blog. |
| "pages": { # The container of pages in this blog. |
| "totalItems": 42, # The count of pages in this blog. |
| "selfLink": "A String", # The URL of the container for pages in this blog. |
| }, |
| "kind": "A String", # The kind of this entry. Always blogger#blog. |
| "locale": { # The locale this Blog is set to. |
| "country": "A String", # The country this blog's locale is set to. |
| "language": "A String", # The language this blog is authored in. |
| "variant": "A String", # The language variant this blog is authored in. |
| }, |
| "updated": "A String", # RFC 3339 date-time when this blog was last updated. |
| "posts": { # The container of posts in this blog. |
| "selfLink": "A String", # The URL of the container for posts in this blog. |
| "items": [ # The List of Posts for this Blog. |
| { |
| "selfLink": "A String", # The API REST URL to fetch this resource from. |
| "author": { # The author of this Post. |
| "displayName": "A String", # The display name. |
| "url": "A String", # The URL of the creator's Profile page. |
| "image": { # The creator's avatar. |
| "url": "A String", # The creator's avatar URL. |
| }, |
| "id": "A String", # The identifier of the creator. |
| }, |
| "etag": "A String", # Etag of the resource. |
| "published": "A String", # RFC 3339 date-time when this Post was published. |
| "images": [ # Display image for the Post. |
| { |
| "url": "A String", |
| }, |
| ], |
| "labels": [ # The list of labels this Post was tagged with. |
| "A String", |
| ], |
| "updated": "A String", # RFC 3339 date-time when this Post was last updated. |
| "location": { # The location for geotagged posts. |
| "lat": 3.14, # Location's latitude. |
| "span": "A String", # Location's viewport span. Can be used when rendering a map preview. |
| "name": "A String", # Location name. |
| "lng": 3.14, # Location's longitude. |
| }, |
| "customMetaData": "A String", # The JSON meta-data for the Post. |
| "id": "A String", # The identifier of this Post. |
| "blog": { # Data about the blog containing this Post. |
| "id": "A String", # The identifier of the Blog that contains this Post. |
| }, |
| "kind": "A String", # The kind of this entity. Always blogger#post. |
| "readerComments": "A String", # Comment control and display setting for readers of this post. |
| "status": "A String", # Status of the post. Only set for admin-level requests. |
| "replies": { # The container of comments on this Post. |
| "totalItems": "A String", # The count of comments on this post. |
| "items": [ # The List of Comments for this Post. |
| { |
| "content": "A String", # The actual content of the comment. May include HTML markup. |
| "id": "A String", # The identifier for this resource. |
| "post": { # Data about the post containing this comment. |
| "id": "A String", # The identifier of the post containing this comment. |
| }, |
| "blog": { # Data about the blog containing this comment. |
| "id": "A String", # The identifier of the blog containing this comment. |
| }, |
| "status": "A String", # The status of the comment (only populated for admin users). |
| "selfLink": "A String", # The API REST URL to fetch this resource from. |
| "updated": "A String", # RFC 3339 date-time when this comment was last updated. |
| "kind": "A String", # The kind of this entry. Always blogger#comment. |
| "inReplyTo": { # Data about the comment this is in reply to. |
| "id": "A String", # The identified of the parent of this comment. |
| }, |
| "published": "A String", # RFC 3339 date-time when this comment was published. |
| "author": { # The author of this Comment. |
| "displayName": "A String", # The display name. |
| "image": { # The creator's avatar. |
| "url": "A String", # The creator's avatar URL. |
| }, |
| "id": "A String", # The identifier of the creator. |
| "url": "A String", # The URL of the creator's Profile page. |
| }, |
| }, |
| ], |
| "selfLink": "A String", # The URL of the comments on this post. |
| }, |
| "title": "A String", # The title of the Post. |
| "url": "A String", # The URL where this Post is displayed. |
| "content": "A String", # The content of the Post. May contain HTML markup. |
| "titleLink": "A String", # The title link URL, similar to atom's related link. |
| }, |
| ], |
| "totalItems": 42, # The count of posts in this blog. |
| }, |
| "published": "A String", # RFC 3339 date-time when this blog was published. |
| "url": "A String", # The URL where this blog is published. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listByUser">listByUser(userId, role=None, status=None, view=None, fetchUserInfo=None, x__xgafv=None)</code> |
| <pre>Lists blogs by user. |
| |
| Args: |
| userId: string, A parameter (required) |
| role: string, A parameter (repeated) |
| status: string, Default value of status is LIVE. (repeated) |
| view: string, A parameter |
| fetchUserInfo: boolean, A parameter |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "blogUserInfos": [ # Admin level list of blog per-user information. |
| { |
| "blog": { # The Blog resource. |
| "description": "A String", # The description of this blog. This is displayed underneath the title. |
| "id": "A String", # The identifier for this resource. |
| "selfLink": "A String", # The API REST URL to fetch this resource from. |
| "name": "A String", # The name of this blog. This is displayed as the title. |
| "customMetaData": "A String", # The JSON custom meta-data for the Blog. |
| "status": "A String", # The status of the blog. |
| "pages": { # The container of pages in this blog. |
| "totalItems": 42, # The count of pages in this blog. |
| "selfLink": "A String", # The URL of the container for pages in this blog. |
| }, |
| "kind": "A String", # The kind of this entry. Always blogger#blog. |
| "locale": { # The locale this Blog is set to. |
| "country": "A String", # The country this blog's locale is set to. |
| "language": "A String", # The language this blog is authored in. |
| "variant": "A String", # The language variant this blog is authored in. |
| }, |
| "updated": "A String", # RFC 3339 date-time when this blog was last updated. |
| "posts": { # The container of posts in this blog. |
| "selfLink": "A String", # The URL of the container for posts in this blog. |
| "items": [ # The List of Posts for this Blog. |
| { |
| "selfLink": "A String", # The API REST URL to fetch this resource from. |
| "author": { # The author of this Post. |
| "displayName": "A String", # The display name. |
| "url": "A String", # The URL of the creator's Profile page. |
| "image": { # The creator's avatar. |
| "url": "A String", # The creator's avatar URL. |
| }, |
| "id": "A String", # The identifier of the creator. |
| }, |
| "etag": "A String", # Etag of the resource. |
| "published": "A String", # RFC 3339 date-time when this Post was published. |
| "images": [ # Display image for the Post. |
| { |
| "url": "A String", |
| }, |
| ], |
| "labels": [ # The list of labels this Post was tagged with. |
| "A String", |
| ], |
| "updated": "A String", # RFC 3339 date-time when this Post was last updated. |
| "location": { # The location for geotagged posts. |
| "lat": 3.14, # Location's latitude. |
| "span": "A String", # Location's viewport span. Can be used when rendering a map preview. |
| "name": "A String", # Location name. |
| "lng": 3.14, # Location's longitude. |
| }, |
| "customMetaData": "A String", # The JSON meta-data for the Post. |
| "id": "A String", # The identifier of this Post. |
| "blog": { # Data about the blog containing this Post. |
| "id": "A String", # The identifier of the Blog that contains this Post. |
| }, |
| "kind": "A String", # The kind of this entity. Always blogger#post. |
| "readerComments": "A String", # Comment control and display setting for readers of this post. |
| "status": "A String", # Status of the post. Only set for admin-level requests. |
| "replies": { # The container of comments on this Post. |
| "totalItems": "A String", # The count of comments on this post. |
| "items": [ # The List of Comments for this Post. |
| { |
| "content": "A String", # The actual content of the comment. May include HTML markup. |
| "id": "A String", # The identifier for this resource. |
| "post": { # Data about the post containing this comment. |
| "id": "A String", # The identifier of the post containing this comment. |
| }, |
| "blog": { # Data about the blog containing this comment. |
| "id": "A String", # The identifier of the blog containing this comment. |
| }, |
| "status": "A String", # The status of the comment (only populated for admin users). |
| "selfLink": "A String", # The API REST URL to fetch this resource from. |
| "updated": "A String", # RFC 3339 date-time when this comment was last updated. |
| "kind": "A String", # The kind of this entry. Always blogger#comment. |
| "inReplyTo": { # Data about the comment this is in reply to. |
| "id": "A String", # The identified of the parent of this comment. |
| }, |
| "published": "A String", # RFC 3339 date-time when this comment was published. |
| "author": { # The author of this Comment. |
| "displayName": "A String", # The display name. |
| "image": { # The creator's avatar. |
| "url": "A String", # The creator's avatar URL. |
| }, |
| "id": "A String", # The identifier of the creator. |
| "url": "A String", # The URL of the creator's Profile page. |
| }, |
| }, |
| ], |
| "selfLink": "A String", # The URL of the comments on this post. |
| }, |
| "title": "A String", # The title of the Post. |
| "url": "A String", # The URL where this Post is displayed. |
| "content": "A String", # The content of the Post. May contain HTML markup. |
| "titleLink": "A String", # The title link URL, similar to atom's related link. |
| }, |
| ], |
| "totalItems": 42, # The count of posts in this blog. |
| }, |
| "published": "A String", # RFC 3339 date-time when this blog was published. |
| "url": "A String", # The URL where this blog is published. |
| }, |
| "kind": "A String", # The kind of this entity. Always blogger#blogUserInfo. |
| "blog_user_info": { # Information about a User for the Blog. |
| "role": "A String", # Access permissions that the user has for the blog (ADMIN, AUTHOR, or |
| # READER). |
| "blogId": "A String", # ID of the Blog resource. |
| "kind": "A String", # The kind of this entity. Always blogger#blogPerUserInfo. |
| "userId": "A String", # ID of the User. |
| "hasAdminAccess": True or False, # True if the user has Admin level access to the blog. |
| "photosAlbumKey": "A String", # The Photo Album Key for the user when adding photos to the blog. |
| }, |
| }, |
| ], |
| "items": [ # The list of Blogs this user has Authorship or Admin rights over. |
| { |
| "description": "A String", # The description of this blog. This is displayed underneath the title. |
| "id": "A String", # The identifier for this resource. |
| "selfLink": "A String", # The API REST URL to fetch this resource from. |
| "name": "A String", # The name of this blog. This is displayed as the title. |
| "customMetaData": "A String", # The JSON custom meta-data for the Blog. |
| "status": "A String", # The status of the blog. |
| "pages": { # The container of pages in this blog. |
| "totalItems": 42, # The count of pages in this blog. |
| "selfLink": "A String", # The URL of the container for pages in this blog. |
| }, |
| "kind": "A String", # The kind of this entry. Always blogger#blog. |
| "locale": { # The locale this Blog is set to. |
| "country": "A String", # The country this blog's locale is set to. |
| "language": "A String", # The language this blog is authored in. |
| "variant": "A String", # The language variant this blog is authored in. |
| }, |
| "updated": "A String", # RFC 3339 date-time when this blog was last updated. |
| "posts": { # The container of posts in this blog. |
| "selfLink": "A String", # The URL of the container for posts in this blog. |
| "items": [ # The List of Posts for this Blog. |
| { |
| "selfLink": "A String", # The API REST URL to fetch this resource from. |
| "author": { # The author of this Post. |
| "displayName": "A String", # The display name. |
| "url": "A String", # The URL of the creator's Profile page. |
| "image": { # The creator's avatar. |
| "url": "A String", # The creator's avatar URL. |
| }, |
| "id": "A String", # The identifier of the creator. |
| }, |
| "etag": "A String", # Etag of the resource. |
| "published": "A String", # RFC 3339 date-time when this Post was published. |
| "images": [ # Display image for the Post. |
| { |
| "url": "A String", |
| }, |
| ], |
| "labels": [ # The list of labels this Post was tagged with. |
| "A String", |
| ], |
| "updated": "A String", # RFC 3339 date-time when this Post was last updated. |
| "location": { # The location for geotagged posts. |
| "lat": 3.14, # Location's latitude. |
| "span": "A String", # Location's viewport span. Can be used when rendering a map preview. |
| "name": "A String", # Location name. |
| "lng": 3.14, # Location's longitude. |
| }, |
| "customMetaData": "A String", # The JSON meta-data for the Post. |
| "id": "A String", # The identifier of this Post. |
| "blog": { # Data about the blog containing this Post. |
| "id": "A String", # The identifier of the Blog that contains this Post. |
| }, |
| "kind": "A String", # The kind of this entity. Always blogger#post. |
| "readerComments": "A String", # Comment control and display setting for readers of this post. |
| "status": "A String", # Status of the post. Only set for admin-level requests. |
| "replies": { # The container of comments on this Post. |
| "totalItems": "A String", # The count of comments on this post. |
| "items": [ # The List of Comments for this Post. |
| { |
| "content": "A String", # The actual content of the comment. May include HTML markup. |
| "id": "A String", # The identifier for this resource. |
| "post": { # Data about the post containing this comment. |
| "id": "A String", # The identifier of the post containing this comment. |
| }, |
| "blog": { # Data about the blog containing this comment. |
| "id": "A String", # The identifier of the blog containing this comment. |
| }, |
| "status": "A String", # The status of the comment (only populated for admin users). |
| "selfLink": "A String", # The API REST URL to fetch this resource from. |
| "updated": "A String", # RFC 3339 date-time when this comment was last updated. |
| "kind": "A String", # The kind of this entry. Always blogger#comment. |
| "inReplyTo": { # Data about the comment this is in reply to. |
| "id": "A String", # The identified of the parent of this comment. |
| }, |
| "published": "A String", # RFC 3339 date-time when this comment was published. |
| "author": { # The author of this Comment. |
| "displayName": "A String", # The display name. |
| "image": { # The creator's avatar. |
| "url": "A String", # The creator's avatar URL. |
| }, |
| "id": "A String", # The identifier of the creator. |
| "url": "A String", # The URL of the creator's Profile page. |
| }, |
| }, |
| ], |
| "selfLink": "A String", # The URL of the comments on this post. |
| }, |
| "title": "A String", # The title of the Post. |
| "url": "A String", # The URL where this Post is displayed. |
| "content": "A String", # The content of the Post. May contain HTML markup. |
| "titleLink": "A String", # The title link URL, similar to atom's related link. |
| }, |
| ], |
| "totalItems": 42, # The count of posts in this blog. |
| }, |
| "published": "A String", # RFC 3339 date-time when this blog was published. |
| "url": "A String", # The URL where this blog is published. |
| }, |
| ], |
| "kind": "A String", # The kind of this entity. Always blogger#blogList. |
| }</pre> |
| </div> |
| |
| </body></html> |
