Posts: getByPath

  • The method getByPath retrieves a post by its path.

  • Authorization is needed if the post is on a private blog.

  • The path is the part of the post URL after the host.

  • Required parameters for the request are blogId and path.

  • Optional parameters include maxComments and view.

Retrieves a post by path. Try it now or see an example.

Authorization is required if the post is on a blog that is private.

The path of a post is the part of the post URL after the host. For example, a blog post with the URL http://code.blogger.com/2011/09/blogger-json-api-now-available.html has a path of /2011/09/blogger-json-api-now-available.html.

Request

HTTP request

GET https://www.googleapis.com/blogger/v3/blogs/blogId/posts/bypath

Parameters

Parameter name Value Description
Required parameters
blogId string The ID of the blog to fetch the post from.
path string Path of the Post to retrieve.
Optional parameters
maxComments unsigned integer Maximum number of comments to retrieve for a post. If this parameter is left unspecified, no comments will be returned as part of the post resource.
view string

Acceptable values are:
  • "ADMIN": Admin level detail
  • "AUTHOR": Author level detail
  • "READER": Admin level detail

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Posts resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library

// The BlogId for the http://buzz.blogger.com/ blog.
String BUZZ_BLOG_ID = "2399
953";
// The URL path component for a
buzz post.String BUZZ_POST_PATH = "/2012/01/engage-with-your-readers
-through.html";
// Configure the Java API Client for
Installed Native AppHttpTransport HTTP_TRANSPORT = new
NetHttpTransport();JsonFactory JSON_FACTORY = n
ew JacksonFactory();
// Configure the Instal
led App OAuth2 flow.Credential credential = OAuth2Native.autho
rize(HTTP_TRANSPORT, JSON_FACTORY, new Lo
calServerReceiver(), Arrays.asList(Blog
gerScopes.BLOGGER)); // Construct the Blogger API a
ccess facade object.Blogger blogger = Blogger.builder(HTTP_TRAN
SPORT, JSON_FACTORY) .setApplicationName("Blogger-Pos
tsGetByPath-Snippet/1.0") .setHttpRequestIn
itializer(credential).b
uild();
// The request action.GetByPath postsGetByPathAction = blogger.po
sts().getByPath(BUZZ_BLOG_ID);postsGetByPathA
ction.setPath(BUZZ_POST_PATH);
// Restrict the result con
tent to just the data we need.postsGetByPathAction.setFiel
ds("content,published,title");
// Th
is step sends the request to the server.Pos
t post = postsGetByPathAction.execute
();
// Now we can navigate the response.System.o
ut.println("Title: " + post.getTitle());System
.out.println("Published: " + post.getPublished());System.out.println("Content: " + post.getContent());

Try it!

Use the APIs Explorer below to call this method on live data and see the response.