Page Summary
-
This method retrieves a list of posts from a blog.
-
Authorization is required for private blogs but not for public ones.
-
The HTTP request is a GET request to the specified endpoint, requiring a
blogId. -
Various optional parameters are available to filter and sort the retrieved posts.
-
The response includes a list of posts and a pagination token if applicable.
Retrieves a list of posts. Try it now or see an example .
Authorization is required if the posts are on a blog that is private. If the posts are on a blog that is public, then this method can be called without authorization.
Request
HTTP request
GET https://www.googleapis.com/blogger/v3/blogs/ blogId /posts
Parameters
blogId
string
fetchBodies
boolean
true
)fetchImages
boolean
labels
string
maxResults
unsigned integer
orderBy
string
Acceptable values are:
- "
published": Order by the date the post was published - "
updated": Order by the date the post was last updated
sortOption
string
UNAVAILABLE NOW
Sort direction applied to results.
Acceptable values are:
- "
descending": Sort posts in descending order in time (default) - "
ascending": Sort posts in ascending order in time
pageToken
string
status
string
Acceptable values are:
- "
draft": Draft posts - "
live": Published posts - "
scheduled": Posts that are scheduled to publish in future.
view
string
Acceptable values are:
- "
ADMIN": Admin level detail - "
AUTHOR": Author level detail - "
READER": Reader level detail
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind" : "blogger#postList" , "nextPageToken" : string , "items" : [ posts Resource ] }
| Property name | Value | Description | Notes |
|---|---|---|---|
kind
|
string
|
The kind of this entity. Always blogger#postList
. |
|
nextPageToken
|
string
|
Pagination token to fetch the next page, if one exists. | |
items[]
|
list
|
The list of posts for this blog. |
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 Blogger Buzz blog String BUZZ_BLOG_ID = "2399953" ;
// 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-PostsList-Snippet/1.0" )
.setHttpRequestInitializer(credential).build();
// The request action.
List postsListAction = blogger.posts().list(BUZZ_BLOG_ID);
// Restrict the result content to just the data we need.
postsListAction .setFields( "items(author/displayName,content,published,title,url),nextPageToken" );
// This step sends the request to the server.
PostList posts = postsListAction.execute();
// Now we can navigate the response.
int postCount = 0;
int pageCount = 0;
while (posts.getItems() != null && !posts.getItems().isEmpty()) {
for (Post post : posts.getItems()) {
System. out .println( "Post #" + ++postCount);
System. out .println( "\tTitle: " +post.getTitle());
System. out .println( "\tAuthor: " +post.getAuthor().getDisplayName());
System. out .println( "\tPublished: " +post.getPublished());
System. out .println( "\tURL: " +post.getUrl());
System. out .println( "\tContent: " +post.getContent());
}
// Pagination logic
String pageToken = posts.getNextPageToken();
if (pageToken == null || ++pageCount >= 5) {
break ;
}
System. out .println( "-- Next page of posts" );
postsListAction.setPageToken(pageToken);
posts = postsListAction.execute();
}
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
