1 API Parameters
_
2 Resources
2.1 pages
blogger-pages-list
blogger-pages-get
2.2 posts
blogger-posts-list
blogger-posts-get
blogger-posts-insert
blogger-posts-patch
blogger-posts-get By Path
blogger-posts-search
blogger-posts-delete
blogger-posts-update
2.3 blogs
blogger-blogs-get
blogger-blogs-get By Url
blogger-blogs-list By User
2.4 comments
blogger-comments-list
blogger-comments-get
2.5 users
blogger-users-get
Version: 5.3

Blogger API v3

This documentation has been automatically generated using information supplied by the Google API Discovery service.

API for access to the data within Blogger. Google documentation.

    1 API Parameters

    2 Resources

      2.1 pages

      2.2 posts

      2.3 blogs

      2.4 comments

      2.5 users

(require-gapi-doc blogger.v3.js)

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure

(_ [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 pages

procedure

(blogger-pages-list #:blogId blogId    
  [#:fetchBodies fetchBodies    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  blogId : string?
  fetchBodies : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Retrieves pages for a blog, possibly filtered.

blogId: ID of the blog to fetch pages from.

fetchBodies: Whether to retrieve the Page bodies.

procedure

(blogger-pages-get #:blogId blogId    
  #:pageId pageId    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  blogId : string?
  pageId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Gets one blog page by id.

blogId: ID of the blog containing the page.

pageId: The ID of the page to get.

2.2 posts

procedure

(blogger-posts-list #:blogId blogId    
  [#:maxResults maxResults    
  #:pageToken pageToken    
  #:labels labels    
  #:endDate endDate    
  #:fetchBodies fetchBodies    
  #:startDate startDate    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  blogId : string?
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  labels : string? = 'N/A
  endDate : string? = 'N/A
  fetchBodies : string? = 'N/A
  startDate : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Retrieves a list of posts, possibly filtered.

blogId: ID of the blog to fetch posts from.

maxResults: Maximum number of posts to fetch.

pageToken: Continuation token if the request is paged.

labels: Comma-separated list of labels to search for.

endDate: Latest post date to fetch, a date-time with RFC 3339 formatting.

fetchBodies: Whether the body content of posts is included.

startDate: Earliest post date to fetch, a date-time with RFC 3339 formatting.

procedure

(blogger-posts-get #:blogId blogId    
  #:postId postId    
  [#:maxComments maxComments    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  blogId : string?
  postId : string?
  maxComments : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Get a post by id.

blogId: ID of the blog to fetch the post from.

postId: The ID of the post

maxComments: Maximum number of comments to pull back on a post.

procedure

(blogger-posts-insert #:blogId blogId 
  [#:id id 
  #:url url 
  #:kind kind 
  #:title title 
  #:selfLink selfLink 
  #:updated updated 
  #:customMetaData customMetaData 
  #:published published 
  #:author author 
  #:blog blog 
  #:content content 
  #:labels labels 
  #:replies replies 
  #:location location 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
  jsexpr?
  blogId : string?
  id : string? = 'N/A
  url : string? = 'N/A
  kind : string? = 'N/A
  title : string? = 'N/A
  selfLink : string? = 'N/A
  updated : string? = 'N/A
  customMetaData : string? = 'N/A
  published : string? = 'N/A
  author : string? = 'N/A
  blog : string? = 'N/A
  content : string? = 'N/A
  labels : string? = 'N/A
  replies : string? = 'N/A
  location : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Add a post.

blogId: ID of the blog to fetch the post from.

id: The identifier of this Post.

url: The URL where this Post is displayed.

kind: The kind of this entity. Always blogger#post

title: The title of the Post.

selfLink: The API REST URL to fetch this resource from.

updated: RFC 3339 date-time when this Post was last updated.

customMetaData: The JSON meta-data for the Post.

published: RFC 3339 date-time when this Post was published.

author: The author of this Post.

blog: Data about the blog containing this Post.

content: The content of the Post. May contain HTML markup.

labels: The list of labels this Post was tagged with.

replies: The container of comments on this Post.

location: The location for geotagged posts.

procedure

(blogger-posts-patch #:blogId blogId    
  #:postId postId    
  [#:id id    
  #:url url    
  #:kind kind    
  #:title title    
  #:selfLink selfLink    
  #:updated updated    
  #:customMetaData customMetaData    
  #:published published    
  #:author author    
  #:blog blog    
  #:content content    
  #:labels labels    
  #:replies replies    
  #:location location    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  blogId : string?
  postId : string?
  id : string? = 'N/A
  url : string? = 'N/A
  kind : string? = 'N/A
  title : string? = 'N/A
  selfLink : string? = 'N/A
  updated : string? = 'N/A
  customMetaData : string? = 'N/A
  published : string? = 'N/A
  author : string? = 'N/A
  blog : string? = 'N/A
  content : string? = 'N/A
  labels : string? = 'N/A
  replies : string? = 'N/A
  location : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Update a post. This method supports patch semantics.

blogId: The ID of the Blog.

postId: The ID of the Post.

id: The identifier of this Post.

url: The URL where this Post is displayed.

kind: The kind of this entity. Always blogger#post

title: The title of the Post.

selfLink: The API REST URL to fetch this resource from.

updated: RFC 3339 date-time when this Post was last updated.

customMetaData: The JSON meta-data for the Post.

published: RFC 3339 date-time when this Post was published.

author: The author of this Post.

blog: Data about the blog containing this Post.

content: The content of the Post. May contain HTML markup.

labels: The list of labels this Post was tagged with.

replies: The container of comments on this Post.

location: The location for geotagged posts.

procedure

(blogger-posts-getByPath #:blogId blogId    
  [#:path path    
  #:maxComments maxComments    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  blogId : string?
  path : string? = 'N/A
  maxComments : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Retrieve a Post by Path.

blogId: ID of the blog to fetch the post from.

path: Path of the Post to retrieve.

maxComments: Maximum number of comments to pull back on a post.

procedure

(blogger-posts-search #:blogId blogId    
  [#:q q    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  blogId : string?
  q : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Search for a post.

blogId: ID of the blog to fetch the post from.

q: Query terms to search this blog for matching posts.

procedure

(blogger-posts-delete #:blogId blogId    
  #:postId postId    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  blogId : string?
  postId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Delete a post by id.

blogId: The Id of the Blog.

postId: The ID of the Post.

procedure

(blogger-posts-update #:blogId blogId 
  #:postId postId 
  [#:id id 
  #:url url 
  #:kind kind 
  #:title title 
  #:selfLink selfLink 
  #:updated updated 
  #:customMetaData customMetaData 
  #:published published 
  #:author author 
  #:blog blog 
  #:content content 
  #:labels labels 
  #:replies replies 
  #:location location 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
  jsexpr?
  blogId : string?
  postId : string?
  id : string? = 'N/A
  url : string? = 'N/A
  kind : string? = 'N/A
  title : string? = 'N/A
  selfLink : string? = 'N/A
  updated : string? = 'N/A
  customMetaData : string? = 'N/A
  published : string? = 'N/A
  author : string? = 'N/A
  blog : string? = 'N/A
  content : string? = 'N/A
  labels : string? = 'N/A
  replies : string? = 'N/A
  location : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Update a post.

blogId: The ID of the Blog.

postId: The ID of the Post.

id: The identifier of this Post.

url: The URL where this Post is displayed.

kind: The kind of this entity. Always blogger#post

title: The title of the Post.

selfLink: The API REST URL to fetch this resource from.

updated: RFC 3339 date-time when this Post was last updated.

customMetaData: The JSON meta-data for the Post.

published: RFC 3339 date-time when this Post was published.

author: The author of this Post.

blog: Data about the blog containing this Post.

content: The content of the Post. May contain HTML markup.

labels: The list of labels this Post was tagged with.

replies: The container of comments on this Post.

location: The location for geotagged posts.

2.3 blogs

procedure

(blogger-blogs-get #:blogId blogId    
  [#:maxPosts maxPosts    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  blogId : string?
  maxPosts : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Gets one blog by id.

blogId: The ID of the blog to get.

maxPosts: Maximum number of posts to pull back with the blog.

procedure

(blogger-blogs-getByUrl [#:url url    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  url : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Retrieve a Blog by URL.

url: The URL of the blog to retrieve.

procedure

(blogger-blogs-listByUser #:userId userId    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  userId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Retrieves a list of blogs, possibly filtered.

userId: ID of the user whose blogs are to be fetched. Either the word ’self’ (sans quote marks) or the user’s profile identifier.

2.4 comments

procedure

(blogger-comments-list #:blogId blogId    
  #:postId postId    
  [#:maxResults maxResults    
  #:pageToken pageToken    
  #:endDate endDate    
  #:fetchBodies fetchBodies    
  #:startDate startDate    
  #:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  blogId : string?
  postId : string?
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  endDate : string? = 'N/A
  fetchBodies : string? = 'N/A
  startDate : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Retrieves the comments for a blog, possibly filtered.

blogId: ID of the blog to fetch comments from.

postId: ID of the post to fetch posts from.

maxResults: Maximum number of comments to include in the result.

pageToken: Continuation token if request is paged.

endDate: Latest date of comment to fetch, a date-time with RFC 3339 formatting.

fetchBodies: Whether the body content of the comments is included.

startDate: Earliest date of comment to fetch, a date-time with RFC 3339 formatting.

procedure

(blogger-comments-get #:blogId blogId    
  #:commentId commentId    
  #:postId postId    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  blogId : string?
  commentId : string?
  postId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Gets one comment by id.

blogId: ID of the blog to containing the comment.

commentId: The ID of the comment to get.

postId: ID of the post to fetch posts from.

2.5 users

procedure

(blogger-users-get #:userId userId    
  [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  userId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Gets one user by id.

userId: The ID of the user to get.