Posts: search
Stay organized with collections
Save and categorize content based on your preferences.
Searches for a post that matches the given query terms.
Try it now or see an example.
Authorization will be required if the blog being searched is private.
Request
HTTP request
GET https://www.googleapis.com/blogger/v3/blogs/blogId/posts/search
Parameters
Parameter name |
Value |
Description |
Required parameters |
blogId |
string |
The ID of the blog to search in.
|
q |
string |
Query terms to search for.
|
Optional parameters |
fetchBodies |
boolean |
Whether the body content of posts is included. To minimize traffic, set this parameter to false when the post's body content is not required.
(Default: true )
|
orderBy |
string |
The sort order applied to the search results.
Acceptable values are:
- "
published ": Order by the date the post was published
- "
updated ": Order by the date the post was last updated
|
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 http://buzz.blogger.com/ 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-PostsSearch-Snippet/1.0")
.setHttpRequestInitializer(credential).build();
// The request action.
Search postsSearchAction = blogger.posts().search(BUZZ_BLOG_ID);
postsSearchAction.setQ("threaded comments");
// Restrict the result content to just the data we need.
postsSearchAction.setFields("items(content,published,title,url)");
// This step sends the request to the server.
PostList posts = postsSearchAction.execute();
// Now we can navigate the response.
if (posts.getItems() != null && !posts.getItems().isEmpty()) {
for (Post post : posts.getItems()) {
System.out.println("Title: " + post.getTitle());
System.out.println("Published: " + post.getPublished());
System.out.println("URL: " + post.getUrl());
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\u003eSearches blog posts matching specified query terms within a given blog.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization for private blogs and allows customization of search results through optional parameters like \u003ccode\u003efetchBodies\u003c/code\u003e and \u003ccode\u003eorderBy\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of posts with metadata, including title, URL, and content (if requested), alongside pagination information.\u003c/p\u003e\n"],["\u003cp\u003eProvides code examples for utilizing this functionality with the Java client library.\u003c/p\u003e\n"],["\u003cp\u003eOffers an interactive API explorer to test the method with live data.\u003c/p\u003e\n"]]],[],null,["# Posts: search\n\nSearches for a post that matches the given query terms.\n[Try it now](#try-it) or [see an example](#examples).\n\n[Authorization](/blogger/docs/3.0/using#auth) will be required if the blog being searched is private.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/blogger/v3/blogs/blogId/posts/search\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Required parameters** |||\n| `blogId` | `string` | The ID of the blog to search in. |\n| `q` | `string` | Query terms to search for. |\n| **Optional parameters** |||\n| `fetchBodies` | `boolean` | Whether the body content of posts is included. To minimize traffic, set this parameter to false when the post's body content is not required. (Default: `true`) |\n| `orderBy` | `string` | The sort order applied to the search results. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`published`\": Order by the date the post was published - \"`updated`\": Order by the date the post was last updated |\n\n### Request body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```objective-c\n{\n \"kind\": \"blogger#postList\",\n \"nextPageToken\": string,\n \"items\": [\n posts Resource\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|-----------------|----------|---------------------------------------------------------|-------|\n| `kind` | `string` | The kind of this entity. Always `blogger#postList` | |\n| `nextPageToken` | `string` | Pagination token to fetch the next page, if one exists. | |\n| `items[]` | `list` | The list of Posts for this Blog. | |\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// 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-PostsSearch-Snippet/1.0\")\n\t.setHttpRequestInitializer(credential).build();\n\n// The request action.\nSearch postsSearchAction = blogger.posts().search(BUZZ_BLOG_ID);\npostsSearchAction.setQ(\"threaded comments\");\n\n// Restrict the result content to just the data we need.\npostsSearchAction.setFields(\"items(content,published,title,url)\");\n\n// This step sends the request to the server.\nPostList posts = postsSearchAction.execute();\n\n// Now we can navigate the response.\nif (posts.getItems() != null && !posts.getItems().isEmpty()) {\n\tfor (Post post : posts.getItems()) {\n\t\tSystem.out.println(\"Title: \" + post.getTitle());\n\t\tSystem.out.println(\"Published: \" + post.getPublished());\n\t\tSystem.out.println(\"URL: \" + post.getUrl());\n\t\tSystem.out.println(\"Content: \" + post.getContent());\n\t}\n}\n```\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]