Posts: getByPath
Stay organized with collections
Save and categorize content based on your preferences.
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 |
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 = "2399953";
// 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 App
HttpTransport HTTP_TRANSPORT = new NetHttpTransport();
JsonFactory JSON_FACTORY = new JacksonFactory();
// Configure the Installed App OAuth2 flow.
Credential credential = OAuth2Native.authorize(HTTP_TRANSPORT,
JSON_FACTORY, new LocalServerReceiver(),
Arrays.asList(BloggerScopes.BLOGGER));
// Construct the Blogger API access facade object.
Blogger blogger = Blogger.builder(HTTP_TRANSPORT, JSON_FACTORY)
.setApplicationName("Blogger-PostsGetByPath-Snippet/1.0")
.setHttpRequestInitializer(credential).build();
// The request action.
GetByPath postsGetByPathAction = blogger.posts().getByPath(BUZZ_BLOG_ID);
postsGetByPathAction.setPath(BUZZ_POST_PATH);
// Restrict the result content to just the data we need.
postsGetByPathAction.setFields("content,published,title");
// This step sends the request to the server.
Post post = postsGetByPathAction.execute();
// Now we can navigate the response.
System.out.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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-08-08 UTC."],[[["\u003cp\u003eRetrieves a specific blog post using its unique path, which is the portion of the post's URL following the host.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization for private blogs and uses the \u003ccode\u003eblogId\u003c/code\u003e and \u003ccode\u003epath\u003c/code\u003e as required parameters in the request.\u003c/p\u003e\n"],["\u003cp\u003eAllows for optional parameters like \u003ccode\u003emaxComments\u003c/code\u003e to limit the number of comments returned and \u003ccode\u003eview\u003c/code\u003e to specify the level of detail in the response.\u003c/p\u003e\n"],["\u003cp\u003eReturns a \u003ccode\u003ePosts\u003c/code\u003e resource containing post details like content, publishing date, and title if the request is successful.\u003c/p\u003e\n"],["\u003cp\u003eProvides a Java code example demonstrating how to use the API to retrieve a post by path, including authorization and data handling.\u003c/p\u003e\n"]]],[],null,["# Posts: getByPath\n\nRetrieves a post by path.\n[Try it now](#try-it) or [see an example](#examples).\n\n[Authorization](/blogger/docs/3.0/using#auth) is required if the post is on a blog that is private. \n\nThe 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`.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/blogger/v3/blogs/blogId/posts/bypath\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Required parameters** |||\n| `blogId` | `string` | The ID of the blog to fetch the post from. |\n| `path` | `string` | Path of the Post to retrieve. |\n| **Optional parameters** |||\n| `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. |\n| `view` | `string` | Acceptable values are: - \"`ADMIN`\": Admin level detail - \"`AUTHOR`\": Author level detail - \"`READER`\": Admin level detail |\n\n### Request body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a [Posts resource](/blogger/docs/3.0/reference/posts#resource) in the response body.\n\nExamples\n--------\n\n**Note:** The code examples available for this method do not represent all supported programming languages (see the [client libraries page](/blogger/docs/3.0/libraries) for a list of supported languages). \n\n### Java\n\nUses the [Java client library](http://code.google.com/p/google-api-java-client/) \n\n```java\n// The BlogId for the http://buzz.blogger.com/ blog.\nString BUZZ_BLOG_ID = \"2399953\";\n\n// The URL path component for a buzz post.\nString BUZZ_POST_PATH = \"/2012/01/engage-with-your-readers-through.html\";\n\n// Configure the Java API Client for Installed Native App\nHttpTransport HTTP_TRANSPORT = new NetHttpTransport();\nJsonFactory JSON_FACTORY = new JacksonFactory();\n\n// Configure the Installed App OAuth2 flow.\nCredential credential = OAuth2Native.authorize(HTTP_TRANSPORT,\n\tJSON_FACTORY, new LocalServerReceiver(),\n\tArrays.asList(BloggerScopes.BLOGGER));\n\n// Construct the Blogger API access facade object.\nBlogger blogger = Blogger.builder(HTTP_TRANSPORT, JSON_FACTORY)\n\t.setApplicationName(\"Blogger-PostsGetByPath-Snippet/1.0\")\n\t.setHttpRequestInitializer(credential).build();\n\n// The request action.\nGetByPath postsGetByPathAction = blogger.posts().getByPath(BUZZ_BLOG_ID);\npostsGetByPathAction.setPath(BUZZ_POST_PATH);\n\n// Restrict the result content to just the data we need.\npostsGetByPathAction.setFields(\"content,published,title\");\n\n// This step sends the request to the server.\nPost post = postsGetByPathAction.execute();\n\n// Now we can navigate the response.\nSystem.out.println(\"Title: \" + post.getTitle());\nSystem.out.println(\"Published: \" + post.getPublished());\nSystem.out.println(\"Content: \" + post.getContent());\n```\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]