blob: a6bc7f2df1fc3d47cdb1ee21180ba4f3b46fcad1 [file] [log] [blame] [edit]
{
"ownerName": "Google",
"servicePath": "",
"rootUrl": "https://blogger.googleapis.com/",
"basePath": "",
"parameters": {
"quotaUser": {
"location": "query",
"type": "string",
"description": "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."
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"access_token": {
"type": "string",
"description": "OAuth access token.",
"location": "query"
},
"$.xgafv": {
"type": "string",
"location": "query",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"enum": [
"1",
"2"
],
"description": "V1 error format."
},
"callback": {
"location": "query",
"type": "string",
"description": "JSONP"
},
"prettyPrint": {
"type": "boolean",
"location": "query",
"default": "true",
"description": "Returns response with indentations and line breaks."
},
"key": {
"location": "query",
"type": "string",
"description": "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."
},
"alt": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"type": "string",
"default": "json",
"location": "query",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
]
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/blogger.readonly": {
"description": "View your Blogger account"
},
"https://www.googleapis.com/auth/blogger": {
"description": "Manage your Blogger account"
}
}
}
},
"documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started",
"canonicalName": "Blogger",
"version": "v3",
"schemas": {
"Comment": {
"type": "object",
"id": "Comment",
"properties": {
"selfLink": {
"type": "string",
"description": "The API REST URL to fetch this resource from."
},
"id": {
"type": "string",
"description": "The identifier for this resource."
},
"blog": {
"description": "Data about the blog containing this comment.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier of the blog containing this comment."
}
}
},
"content": {
"type": "string",
"description": "The actual content of the comment. May include HTML markup."
},
"updated": {
"description": "RFC 3339 date-time when this comment was last updated.",
"type": "string"
},
"status": {
"type": "string",
"description": "The status of the comment (only populated for admin users).",
"enum": [
"LIVE",
"EMPTIED",
"PENDING",
"SPAM"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"author": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL of the creator's Profile page."
},
"image": {
"description": "The creator's avatar.",
"type": "object",
"properties": {
"url": {
"description": "The creator's avatar URL.",
"type": "string"
}
}
},
"id": {
"description": "The identifier of the creator.",
"type": "string"
},
"displayName": {
"type": "string",
"description": "The display name."
}
},
"description": "The author of this Comment."
},
"kind": {
"description": "The kind of this entry. Always blogger#comment.",
"type": "string"
},
"post": {
"type": "object",
"description": "Data about the post containing this comment.",
"properties": {
"id": {
"type": "string",
"description": "The identifier of the post containing this comment."
}
}
},
"inReplyTo": {
"description": "Data about the comment this is in reply to.",
"properties": {
"id": {
"type": "string",
"description": "The identified of the parent of this comment."
}
},
"type": "object"
},
"published": {
"description": "RFC 3339 date-time when this comment was published.",
"type": "string"
}
}
},
"Page": {
"id": "Page",
"properties": {
"title": {
"type": "string",
"description": "The title of this entity. This is the name displayed in the Admin user interface."
},
"status": {
"enumDescriptions": [
"",
""
],
"description": "The status of the page for admin resources (either LIVE or DRAFT).",
"enum": [
"LIVE",
"DRAFT"
],
"type": "string"
},
"author": {
"description": "The author of this Page.",
"properties": {
"id": {
"type": "string",
"description": "The identifier of the creator."
},
"image": {
"description": "The creator's avatar.",
"properties": {
"url": {
"type": "string",
"description": "The creator's avatar URL."
}
},
"type": "object"
},
"displayName": {
"description": "The display name.",
"type": "string"
},
"url": {
"description": "The URL of the creator's Profile page.",
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string",
"description": "The identifier for this resource."
},
"kind": {
"description": "The kind of this entity. Always blogger#page.",
"type": "string"
},
"etag": {
"description": "Etag of the resource.",
"type": "string"
},
"url": {
"type": "string",
"description": "The URL that this Page is displayed at."
},
"blog": {
"properties": {
"id": {
"type": "string",
"description": "The identifier of the blog containing this page."
}
},
"type": "object",
"description": "Data about the blog containing this Page."
},
"updated": {
"description": "RFC 3339 date-time when this Page was last updated.",
"type": "string"
},
"selfLink": {
"description": "The API REST URL to fetch this resource from.",
"type": "string"
},
"published": {
"description": "RFC 3339 date-time when this Page was published.",
"type": "string"
},
"content": {
"type": "string",
"description": "The body content of this Page, in HTML."
}
},
"type": "object"
},
"Pageviews": {
"type": "object",
"properties": {
"kind": {
"description": "The kind of this entry. Always blogger#page_views.",
"type": "string"
},
"blogId": {
"description": "Blog Id.",
"type": "string"
},
"counts": {
"type": "array",
"items": {
"properties": {
"count": {
"description": "Count of page views for the given time range.",
"format": "int64",
"type": "string"
},
"timeRange": {
"type": "string",
"enum": [
"ALL_TIME",
"THIRTY_DAYS",
"SEVEN_DAYS"
],
"enumDescriptions": [
"",
"",
""
],
"description": "Time range the given count applies to."
}
},
"type": "object"
},
"description": "The container of posts in this blog."
}
},
"id": "Pageviews"
},
"PageList": {
"properties": {
"kind": {
"type": "string",
"description": "The kind of this entity. Always blogger#pageList."
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to fetch the next page, if one exists."
},
"items": {
"type": "array",
"description": "The list of Pages for a Blog.",
"items": {
"$ref": "Page"
}
},
"etag": {
"type": "string",
"description": "Etag of the response."
}
},
"type": "object",
"id": "PageList"
},
"Post": {
"id": "Post",
"properties": {
"location": {
"properties": {
"lng": {
"format": "double",
"type": "number",
"description": "Location's longitude."
},
"span": {
"description": "Location's viewport span. Can be used when rendering a map preview.",
"type": "string"
},
"name": {
"description": "Location name.",
"type": "string"
},
"lat": {
"format": "double",
"description": "Location's latitude.",
"type": "number"
}
},
"type": "object",
"description": "The location for geotagged posts."
},
"status": {
"enumDescriptions": [
"",
"",
""
],
"enum": [
"LIVE",
"DRAFT",
"SCHEDULED"
],
"description": "Status of the post. Only set for admin-level requests.",
"type": "string"
},
"images": {
"description": "Display image for the Post.",
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
},
"replies": {
"properties": {
"selfLink": {
"description": "The URL of the comments on this post.",
"type": "string"
},
"totalItems": {
"type": "string",
"description": "The count of comments on this post.",
"format": "int64"
},
"items": {
"description": "The List of Comments for this Post.",
"items": {
"$ref": "Comment"
},
"type": "array"
}
},
"description": "The container of comments on this Post.",
"type": "object"
},
"author": {
"type": "object",
"description": "The author of this Post.",
"properties": {
"url": {
"type": "string",
"description": "The URL of the creator's Profile page."
},
"id": {
"type": "string",
"description": "The identifier of the creator."
},
"image": {
"type": "object",
"description": "The creator's avatar.",
"properties": {
"url": {
"type": "string",
"description": "The creator's avatar URL."
}
}
},
"displayName": {
"type": "string",
"description": "The display name."
}
}
},
"updated": {
"type": "string",
"description": "RFC 3339 date-time when this Post was last updated."
},
"etag": {
"type": "string",
"description": "Etag of the resource."
},
"published": {
"description": "RFC 3339 date-time when this Post was published.",
"type": "string"
},
"id": {
"description": "The identifier of this Post.",
"type": "string"
},
"customMetaData": {
"type": "string",
"description": "The JSON meta-data for the Post."
},
"blog": {
"description": "Data about the blog containing this Post.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The identifier of the Blog that contains this Post."
}
}
},
"selfLink": {
"type": "string",
"description": "The API REST URL to fetch this resource from."
},
"content": {
"description": "The content of the Post. May contain HTML markup.",
"type": "string"
},
"title": {
"type": "string",
"description": "The title of the Post."
},
"kind": {
"description": "The kind of this entity. Always blogger#post.",
"type": "string"
},
"url": {
"description": "The URL where this Post is displayed.",
"type": "string"
},
"labels": {
"description": "The list of labels this Post was tagged with.",
"items": {
"type": "string"
},
"type": "array"
},
"readerComments": {
"type": "string",
"enum": [
"ALLOW",
"DONT_ALLOW_SHOW_EXISTING",
"DONT_ALLOW_HIDE_EXISTING"
],
"enumDescriptions": [
"",
"",
""
],
"description": "Comment control and display setting for readers of this post."
},
"titleLink": {
"description": "The title link URL, similar to atom's related link.",
"type": "string"
}
},
"type": "object"
},
"PostUserInfosList": {
"type": "object",
"id": "PostUserInfosList",
"properties": {
"items": {
"type": "array",
"description": "The list of Posts with User information for the post, for this Blog.",
"items": {
"$ref": "PostUserInfo"
}
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to fetch the next page, if one exists."
},
"kind": {
"description": "The kind of this entity. Always blogger#postList.",
"type": "string"
}
}
},
"PostList": {
"properties": {
"prevPageToken": {
"type": "string",
"description": "Pagination token to fetch the previous page, if one exists."
},
"etag": {
"type": "string",
"description": "Etag of the response."
},
"kind": {
"description": "The kind of this entity. Always blogger#postList.",
"type": "string"
},
"nextPageToken": {
"type": "string",
"description": "Pagination token to fetch the next page, if one exists."
},
"items": {
"items": {
"$ref": "Post"
},
"description": "The list of Posts for this Blog.",
"type": "array"
}
},
"id": "PostList",
"type": "object"
},
"CommentList": {
"properties": {
"kind": {
"type": "string",
"description": "The kind of this entry. Always blogger#commentList."
},
"nextPageToken": {
"description": "Pagination token to fetch the next page, if one exists.",
"type": "string"
},
"items": {
"description": "The List of Comments for a Post.",
"items": {
"$ref": "Comment"
},
"type": "array"
},
"etag": {
"description": "Etag of the response.",
"type": "string"
},
"prevPageToken": {
"description": "Pagination token to fetch the previous page, if one exists.",
"type": "string"
}
},
"type": "object",
"id": "CommentList"
},
"User": {
"type": "object",
"id": "User",
"properties": {
"locale": {
"type": "object",
"description": "This user's locale",
"properties": {
"variant": {
"type": "string",
"description": "The language variant this blog is authored in."
},
"country": {
"type": "string",
"description": "The country this blog's locale is set to."
},
"language": {
"description": "The language this blog is authored in.",
"type": "string"
}
}
},
"url": {
"description": "The user's profile page.",
"type": "string"
},
"created": {
"description": "The timestamp of when this profile was created, in seconds since epoch.",
"type": "string"
},
"kind": {
"description": "The kind of this entity. Always blogger#user.",
"type": "string"
},
"about": {
"description": "Profile summary information.",
"type": "string"
},
"selfLink": {
"type": "string",
"description": "The API REST URL to fetch this resource from."
},
"id": {
"description": "The identifier for this User.",
"type": "string"
},
"blogs": {
"properties": {
"selfLink": {
"description": "The URL of the Blogs for this user.",
"type": "string"
}
},
"type": "object",
"description": "The container of blogs for this user."
},
"displayName": {
"description": "The display name.",
"type": "string"
}
}
},
"BlogList": {
"type": "object",
"properties": {
"blogUserInfos": {
"description": "Admin level list of blog per-user information.",
"items": {
"$ref": "BlogUserInfo"
},
"type": "array"
},
"kind": {
"description": "The kind of this entity. Always blogger#blogList.",
"type": "string"
},
"items": {
"type": "array",
"description": "The list of Blogs this user has Authorship or Admin rights over.",
"items": {
"$ref": "Blog"
}
}
},
"id": "BlogList"
},
"PostUserInfo": {
"id": "PostUserInfo",
"type": "object",
"properties": {
"post_user_info": {
"description": "Information about a User for the Post.",
"$ref": "PostPerUserInfo"
},
"kind": {
"type": "string",
"description": "The kind of this entity. Always blogger#postUserInfo."
},
"post": {
"$ref": "Post",
"description": "The Post resource."
}
}
},
"Blog": {
"type": "object",
"properties": {
"published": {
"type": "string",
"description": "RFC 3339 date-time when this blog was published."
},
"id": {
"description": "The identifier for this resource.",
"type": "string"
},
"status": {
"description": "The status of the blog.",
"enumDescriptions": [
"",
""
],
"enum": [
"LIVE",
"DELETED"
],
"type": "string"
},
"locale": {
"type": "object",
"properties": {
"language": {
"description": "The language this blog is authored in.",
"type": "string"
},
"country": {
"type": "string",
"description": "The country this blog's locale is set to."
},
"variant": {
"description": "The language variant this blog is authored in.",
"type": "string"
}
},
"description": "The locale this Blog is set to."
},
"updated": {
"type": "string",
"description": "RFC 3339 date-time when this blog was last updated."
},
"description": {
"type": "string",
"description": "The description of this blog. This is displayed underneath the title."
},
"kind": {
"type": "string",
"description": "The kind of this entry. Always blogger#blog."
},
"url": {
"type": "string",
"description": "The URL where this blog is published."
},
"posts": {
"properties": {
"totalItems": {
"description": "The count of posts in this blog.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "The List of Posts for this Blog.",
"type": "array",
"items": {
"$ref": "Post"
}
},
"selfLink": {
"type": "string",
"description": "The URL of the container for posts in this blog."
}
},
"type": "object",
"description": "The container of posts in this blog."
},
"name": {
"type": "string",
"description": "The name of this blog. This is displayed as the title."
},
"customMetaData": {
"description": "The JSON custom meta-data for the Blog.",
"type": "string"
},
"selfLink": {
"type": "string",
"description": "The API REST URL to fetch this resource from."
},
"pages": {
"type": "object",
"description": "The container of pages in this blog.",
"properties": {
"totalItems": {
"description": "The count of pages in this blog.",
"type": "integer",
"format": "int32"
},
"selfLink": {
"type": "string",
"description": "The URL of the container for pages in this blog."
}
}
}
},
"id": "Blog"
},
"PostPerUserInfo": {
"type": "object",
"id": "PostPerUserInfo",
"properties": {
"blogId": {
"description": "ID of the Blog that the post resource belongs to.",
"type": "string"
},
"userId": {
"type": "string",
"description": "ID of the User."
},
"hasEditAccess": {
"type": "boolean",
"description": "True if the user has Author level access to the post."
},
"kind": {
"description": "The kind of this entity. Always blogger#postPerUserInfo.",
"type": "string"
},
"postId": {
"description": "ID of the Post resource.",
"type": "string"
}
}
},
"BlogPerUserInfo": {
"id": "BlogPerUserInfo",
"properties": {
"blogId": {
"description": "ID of the Blog resource.",
"type": "string"
},
"role": {
"description": "Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).",
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string",
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
]
},
"kind": {
"description": "The kind of this entity. Always blogger#blogPerUserInfo.",
"type": "string"
},
"photosAlbumKey": {
"description": "The Photo Album Key for the user when adding photos to the blog.",
"type": "string"
},
"hasAdminAccess": {
"description": "True if the user has Admin level access to the blog.",
"type": "boolean"
},
"userId": {
"type": "string",
"description": "ID of the User."
}
},
"type": "object"
},
"BlogUserInfo": {
"properties": {
"kind": {
"description": "The kind of this entity. Always blogger#blogUserInfo.",
"type": "string"
},
"blog": {
"description": "The Blog resource.",
"$ref": "Blog"
},
"blog_user_info": {
"$ref": "BlogPerUserInfo",
"description": "Information about a User for the Blog."
}
},
"type": "object",
"id": "BlogUserInfo"
}
},
"id": "blogger:v3",
"protocol": "rest",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"kind": "discovery#restDescription",
"discoveryVersion": "v1",
"description": "The Blogger API provides access to posts, comments and pages of a Blogger blog.",
"resources": {
"postUserInfos": {
"methods": {
"get": {
"flatPath": "v3/users/{userId}/blogs/{blogId}/posts/{postId}",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"description": "Gets one post and user info pair, by post_id and user_id.",
"parameters": {
"postId": {
"required": true,
"type": "string",
"location": "path"
},
"blogId": {
"location": "path",
"required": true,
"type": "string"
},
"maxComments": {
"type": "integer",
"format": "uint32",
"location": "query"
},
"userId": {
"type": "string",
"required": true,
"location": "path"
}
},
"path": "v3/users/{userId}/blogs/{blogId}/posts/{postId}",
"parameterOrder": [
"userId",
"blogId",
"postId"
],
"response": {
"$ref": "PostUserInfo"
},
"id": "blogger.postUserInfos.get"
},
"list": {
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"response": {
"$ref": "PostUserInfosList"
},
"id": "blogger.postUserInfos.list",
"path": "v3/users/{userId}/blogs/{blogId}/posts",
"description": "Lists post and user info pairs.",
"parameters": {
"startDate": {
"location": "query",
"type": "string"
},
"maxResults": {
"format": "uint32",
"type": "integer",
"location": "query"
},
"userId": {
"required": true,
"location": "path",
"type": "string"
},
"labels": {
"type": "string",
"location": "query"
},
"status": {
"enumDescriptions": [
"",
"",
""
],
"type": "string",
"location": "query",
"enum": [
"LIVE",
"DRAFT",
"SCHEDULED"
],
"repeated": true
},
"blogId": {
"type": "string",
"required": true,
"location": "path"
},
"pageToken": {
"type": "string",
"location": "query"
},
"view": {
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
],
"location": "query",
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"orderBy": {
"type": "string",
"enum": [
"ORDER_BY_UNSPECIFIED",
"PUBLISHED",
"UPDATED"
],
"enumDescriptions": [
"",
"",
""
],
"location": "query",
"default": "PUBLISHED"
},
"endDate": {
"type": "string",
"location": "query"
},
"fetchBodies": {
"location": "query",
"type": "boolean",
"default": "false"
}
},
"httpMethod": "GET",
"parameterOrder": [
"userId",
"blogId"
],
"flatPath": "v3/users/{userId}/blogs/{blogId}/posts"
}
}
},
"blogUserInfos": {
"methods": {
"get": {
"parameterOrder": [
"userId",
"blogId"
],
"flatPath": "v3/users/{userId}/blogs/{blogId}",
"path": "v3/users/{userId}/blogs/{blogId}",
"id": "blogger.blogUserInfos.get",
"response": {
"$ref": "BlogUserInfo"
},
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"httpMethod": "GET",
"parameters": {
"userId": {
"required": true,
"type": "string",
"location": "path"
},
"maxPosts": {
"format": "uint32",
"location": "query",
"type": "integer"
},
"blogId": {
"type": "string",
"required": true,
"location": "path"
}
},
"description": "Gets one blog and user info pair by blog id and user id."
}
}
},
"comments": {
"methods": {
"markAsSpam": {
"response": {
"$ref": "Comment"
},
"id": "blogger.comments.markAsSpam",
"parameters": {
"postId": {
"location": "path",
"type": "string",
"required": true
},
"blogId": {
"location": "path",
"required": true,
"type": "string"
},
"commentId": {
"location": "path",
"type": "string",
"required": true
}
},
"httpMethod": "POST",
"parameterOrder": [
"blogId",
"postId",
"commentId"
],
"description": "Marks a comment as spam by blog id, post id and comment id.",
"path": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/spam",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"flatPath": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/spam"
},
"approve": {
"path": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/approve",
"parameters": {
"commentId": {
"location": "path",
"type": "string",
"required": true
},
"postId": {
"location": "path",
"required": true,
"type": "string"
},
"blogId": {
"location": "path",
"required": true,
"type": "string"
}
},
"parameterOrder": [
"blogId",
"postId",
"commentId"
],
"response": {
"$ref": "Comment"
},
"httpMethod": "POST",
"description": "Marks a comment as not spam by blog id, post id and comment id.",
"id": "blogger.comments.approve",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"flatPath": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/approve"
},
"get": {
"id": "blogger.comments.get",
"path": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}",
"response": {
"$ref": "Comment"
},
"flatPath": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}",
"description": "Gets a comment by id.",
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"parameters": {
"postId": {
"type": "string",
"location": "path",
"required": true
},
"blogId": {
"location": "path",
"type": "string",
"required": true
},
"commentId": {
"location": "path",
"required": true,
"type": "string"
},
"view": {
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
],
"type": "string",
"location": "query",
"enumDescriptions": [
"",
"",
"",
""
]
}
},
"parameterOrder": [
"blogId",
"postId",
"commentId"
],
"httpMethod": "GET"
},
"delete": {
"flatPath": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}",
"description": "Deletes a comment by blog id, post id and comment id.",
"path": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}",
"id": "blogger.comments.delete",
"parameterOrder": [
"blogId",
"postId",
"commentId"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"parameters": {
"postId": {
"location": "path",
"required": true,
"type": "string"
},
"commentId": {
"location": "path",
"required": true,
"type": "string"
},
"blogId": {
"required": true,
"type": "string",
"location": "path"
}
}
},
"listByBlog": {
"path": "v3/blogs/{blogId}/comments",
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"id": "blogger.comments.listByBlog",
"httpMethod": "GET",
"response": {
"$ref": "CommentList"
},
"parameters": {
"status": {
"enum": [
"LIVE",
"EMPTIED",
"PENDING",
"SPAM"
],
"location": "query",
"type": "string",
"enumDescriptions": [
"",
"",
"",
""
],
"repeated": true
},
"endDate": {
"type": "string",
"location": "query"
},
"pageToken": {
"location": "query",
"type": "string"
},
"maxResults": {
"location": "query",
"format": "uint32",
"type": "integer"
},
"fetchBodies": {
"location": "query",
"type": "boolean"
},
"blogId": {
"required": true,
"type": "string",
"location": "path"
},
"startDate": {
"type": "string",
"location": "query"
}
},
"parameterOrder": [
"blogId"
],
"flatPath": "v3/blogs/{blogId}/comments",
"description": "Lists comments by blog."
},
"list": {
"response": {
"$ref": "CommentList"
},
"id": "blogger.comments.list",
"description": "Lists comments.",
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"parameterOrder": [
"blogId",
"postId"
],
"flatPath": "v3/blogs/{blogId}/posts/{postId}/comments",
"path": "v3/blogs/{blogId}/posts/{postId}/comments",
"parameters": {
"blogId": {
"type": "string",
"required": true,
"location": "path"
},
"pageToken": {
"type": "string",
"location": "query"
},
"maxResults": {
"location": "query",
"type": "integer",
"format": "uint32"
},
"postId": {
"type": "string",
"location": "path",
"required": true
},
"startDate": {
"type": "string",
"location": "query"
},
"endDate": {
"location": "query",
"type": "string"
},
"fetchBodies": {
"location": "query",
"type": "boolean"
},
"status": {
"enum": [
"LIVE",
"EMPTIED",
"PENDING",
"SPAM"
],
"location": "query",
"type": "string",
"enumDescriptions": [
"",
"",
"",
""
]
},
"view": {
"type": "string",
"location": "query",
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
]
}
},
"httpMethod": "GET"
},
"removeContent": {
"path": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent",
"parameters": {
"postId": {
"type": "string",
"location": "path",
"required": true
},
"commentId": {
"location": "path",
"required": true,
"type": "string"
},
"blogId": {
"required": true,
"type": "string",
"location": "path"
}
},
"description": "Removes the content of a comment by blog id, post id and comment id.",
"httpMethod": "POST",
"parameterOrder": [
"blogId",
"postId",
"commentId"
],
"id": "blogger.comments.removeContent",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"flatPath": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent",
"response": {
"$ref": "Comment"
}
}
}
},
"posts": {
"methods": {
"revert": {
"response": {
"$ref": "Post"
},
"path": "v3/blogs/{blogId}/posts/{postId}/revert",
"parameterOrder": [
"blogId",
"postId"
],
"id": "blogger.posts.revert",
"description": "Reverts a published or scheduled post to draft state.",
"httpMethod": "POST",
"parameters": {
"blogId": {
"required": true,
"location": "path",
"type": "string"
},
"postId": {
"location": "path",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"flatPath": "v3/blogs/{blogId}/posts/{postId}/revert"
},
"insert": {
"parameters": {
"fetchImages": {
"type": "boolean",
"location": "query"
},
"isDraft": {
"location": "query",
"type": "boolean"
},
"blogId": {
"required": true,
"type": "string",
"location": "path"
},
"fetchBody": {
"location": "query",
"default": "true",
"type": "boolean"
}
},
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"response": {
"$ref": "Post"
},
"request": {
"$ref": "Post"
},
"flatPath": "v3/blogs/{blogId}/posts",
"path": "v3/blogs/{blogId}/posts",
"parameterOrder": [
"blogId"
],
"id": "blogger.posts.insert",
"description": "Inserts a post."
},
"list": {
"description": "Lists posts.",
"flatPath": "v3/blogs/{blogId}/posts",
"id": "blogger.posts.list",
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"parameterOrder": [
"blogId"
],
"parameters": {
"endDate": {
"type": "string",
"location": "query"
},
"pageToken": {
"type": "string",
"location": "query"
},
"maxResults": {
"location": "query",
"format": "uint32",
"type": "integer"
},
"startDate": {
"location": "query",
"type": "string"
},
"labels": {
"location": "query",
"type": "string"
},
"blogId": {
"required": true,
"location": "path",
"type": "string"
},
"status": {
"enum": [
"LIVE",
"DRAFT",
"SCHEDULED"
],
"type": "string",
"enumDescriptions": [
"",
"",
""
],
"repeated": true,
"location": "query"
},
"orderBy": {
"location": "query",
"enum": [
"ORDER_BY_UNSPECIFIED",
"PUBLISHED",
"UPDATED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string",
"default": "PUBLISHED"
},
"view": {
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
],
"type": "string",
"location": "query"
},
"fetchImages": {
"type": "boolean",
"location": "query"
},
"fetchBodies": {
"type": "boolean",
"default": "true",
"location": "query"
}
},
"httpMethod": "GET",
"path": "v3/blogs/{blogId}/posts",
"response": {
"$ref": "PostList"
}
},
"getByPath": {
"parameterOrder": [
"blogId",
"path"
],
"id": "blogger.posts.getByPath",
"flatPath": "v3/blogs/{blogId}/posts/bypath",
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"description": "Gets a post by path.",
"path": "v3/blogs/{blogId}/posts/bypath",
"httpMethod": "GET",
"response": {
"$ref": "Post"
},
"parameters": {
"blogId": {
"location": "path",
"required": true,
"type": "string"
},
"path": {
"required": true,
"type": "string",
"location": "query"
},
"view": {
"location": "query",
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string",
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
]
},
"maxComments": {
"format": "uint32",
"type": "integer",
"location": "query"
}
}
},
"get": {
"path": "v3/blogs/{blogId}/posts/{postId}",
"description": "Gets a post by blog id and post id",
"flatPath": "v3/blogs/{blogId}/posts/{postId}",
"parameters": {
"maxComments": {
"format": "uint32",
"type": "integer",
"location": "query"
},
"blogId": {
"required": true,
"type": "string",
"location": "path"
},
"fetchBody": {
"default": "true",
"type": "boolean",
"location": "query"
},
"view": {
"location": "query",
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"fetchImages": {
"location": "query",
"type": "boolean"
},
"postId": {
"required": true,
"location": "path",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"parameterOrder": [
"blogId",
"postId"
],
"response": {
"$ref": "Post"
},
"httpMethod": "GET",
"id": "blogger.posts.get"
},
"delete": {
"parameterOrder": [
"blogId",
"postId"
],
"id": "blogger.posts.delete",
"path": "v3/blogs/{blogId}/posts/{postId}",
"parameters": {
"postId": {
"required": true,
"type": "string",
"location": "path"
},
"blogId": {
"location": "path",
"type": "string",
"required": true
}
},
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"flatPath": "v3/blogs/{blogId}/posts/{postId}",
"description": "Deletes a post by blog id and post id."
},
"patch": {
"parameters": {
"publish": {
"location": "query",
"type": "boolean"
},
"blogId": {
"type": "string",
"location": "path",
"required": true
},
"fetchBody": {
"default": "true",
"location": "query",
"type": "boolean"
},
"maxComments": {
"location": "query",
"type": "integer",
"format": "uint32"
},
"revert": {
"type": "boolean",
"location": "query"
},
"postId": {
"required": true,
"location": "path",
"type": "string"
},
"fetchImages": {
"type": "boolean",
"location": "query"
}
},
"request": {
"$ref": "Post"
},
"httpMethod": "PATCH",
"parameterOrder": [
"blogId",
"postId"
],
"flatPath": "v3/blogs/{blogId}/posts/{postId}",
"description": "Patches a post.",
"id": "blogger.posts.patch",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"path": "v3/blogs/{blogId}/posts/{postId}",
"response": {
"$ref": "Post"
}
},
"update": {
"id": "blogger.posts.update",
"response": {
"$ref": "Post"
},
"description": "Updates a post by blog id and post id.",
"request": {
"$ref": "Post"
},
"flatPath": "v3/blogs/{blogId}/posts/{postId}",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"parameterOrder": [
"blogId",
"postId"
],
"path": "v3/blogs/{blogId}/posts/{postId}",
"parameters": {
"maxComments": {
"type": "integer",
"location": "query",
"format": "uint32"
},
"publish": {
"type": "boolean",
"location": "query"
},
"blogId": {
"type": "string",
"location": "path",
"required": true
},
"fetchImages": {
"type": "boolean",
"location": "query"
},
"postId": {
"location": "path",
"type": "string",
"required": true
},
"fetchBody": {
"type": "boolean",
"location": "query",
"default": "true"
},
"revert": {
"location": "query",
"type": "boolean"
}
},
"httpMethod": "PUT"
},
"search": {
"path": "v3/blogs/{blogId}/posts/search",
"id": "blogger.posts.search",
"parameterOrder": [
"blogId",
"q"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"description": "Searches for posts matching given query terms in the specified blog.",
"parameters": {
"fetchBodies": {
"location": "query",
"default": "true",
"type": "boolean"
},
"orderBy": {
"default": "PUBLISHED",
"location": "query",
"enumDescriptions": [
"",
"",
""
],
"type": "string",
"enum": [
"ORDER_BY_UNSPECIFIED",
"PUBLISHED",
"UPDATED"
]
},
"q": {
"location": "query",
"required": true,
"type": "string"
},
"blogId": {
"location": "path",
"required": true,
"type": "string"
}
},
"response": {
"$ref": "PostList"
},
"flatPath": "v3/blogs/{blogId}/posts/search"
},
"publish": {
"id": "blogger.posts.publish",
"httpMethod": "POST",
"path": "v3/blogs/{blogId}/posts/{postId}/publish",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"parameterOrder": [
"blogId",
"postId"
],
"description": "Publishes a post.",
"flatPath": "v3/blogs/{blogId}/posts/{postId}/publish",
"parameters": {
"publishDate": {
"type": "string",
"location": "query"
},
"blogId": {
"type": "string",
"required": true,
"location": "path"
},
"postId": {
"location": "path",
"required": true,
"type": "string"
}
},
"response": {
"$ref": "Post"
}
}
}
},
"pageViews": {
"methods": {
"get": {
"description": "Gets page views by blog id.",
"response": {
"$ref": "Pageviews"
},
"parameterOrder": [
"blogId"
],
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"httpMethod": "GET",
"path": "v3/blogs/{blogId}/pageviews",
"flatPath": "v3/blogs/{blogId}/pageviews",
"parameters": {
"range": {
"repeated": true,
"location": "query",
"type": "string",
"enum": [
"all",
"30DAYS",
"7DAYS"
],
"enumDescriptions": [
"",
"",
""
]
},
"blogId": {
"location": "path",
"required": true,
"type": "string"
}
},
"id": "blogger.pageViews.get"
}
}
},
"pages": {
"methods": {
"list": {
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"response": {
"$ref": "PageList"
},
"parameters": {
"blogId": {
"type": "string",
"required": true,
"location": "path"
},
"fetchBodies": {
"type": "boolean",
"location": "query"
},
"maxResults": {
"type": "integer",
"format": "uint32",
"location": "query"
},
"status": {
"repeated": true,
"location": "query",
"type": "string",
"enumDescriptions": [
"",
""
],
"enum": [
"LIVE",
"DRAFT"
]
},
"view": {
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string",
"location": "query",
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
]
},
"pageToken": {
"location": "query",
"type": "string"
}
},
"description": "Lists pages.",
"flatPath": "v3/blogs/{blogId}/pages",
"id": "blogger.pages.list",
"path": "v3/blogs/{blogId}/pages",
"parameterOrder": [
"blogId"
],
"httpMethod": "GET"
},
"update": {
"request": {
"$ref": "Page"
},
"parameterOrder": [
"blogId",
"pageId"
],
"path": "v3/blogs/{blogId}/pages/{pageId}",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"httpMethod": "PUT",
"id": "blogger.pages.update",
"parameters": {
"revert": {
"type": "boolean",
"location": "query"
},
"pageId": {
"required": true,
"type": "string",
"location": "path"
},
"blogId": {
"required": true,
"location": "path",
"type": "string"
},
"publish": {
"type": "boolean",
"location": "query"
}
},
"description": "Updates a page by blog id and page id.",
"response": {
"$ref": "Page"
},
"flatPath": "v3/blogs/{blogId}/pages/{pageId}"
},
"delete": {
"flatPath": "v3/blogs/{blogId}/pages/{pageId}",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"parameterOrder": [
"blogId",
"pageId"
],
"parameters": {
"pageId": {
"type": "string",
"location": "path",
"required": true
},
"blogId": {
"required": true,
"type": "string",
"location": "path"
}
},
"httpMethod": "DELETE",
"path": "v3/blogs/{blogId}/pages/{pageId}",
"id": "blogger.pages.delete",
"description": "Deletes a page by blog id and page id."
},
"publish": {
"path": "v3/blogs/{blogId}/pages/{pageId}/publish",
"description": "Publishes a page.",
"httpMethod": "POST",
"parameterOrder": [
"blogId",
"pageId"
],
"id": "blogger.pages.publish",
"parameters": {
"pageId": {
"location": "path",
"type": "string",
"required": true
},
"blogId": {
"location": "path",
"required": true,
"type": "string"
}
},
"response": {
"$ref": "Page"
},
"flatPath": "v3/blogs/{blogId}/pages/{pageId}/publish",
"scopes": [
"https://www.googleapis.com/auth/blogger"
]
},
"insert": {
"response": {
"$ref": "Page"
},
"id": "blogger.pages.insert",
"flatPath": "v3/blogs/{blogId}/pages",
"path": "v3/blogs/{blogId}/pages",
"description": "Inserts a page.",
"parameters": {
"blogId": {
"location": "path",
"type": "string",
"required": true
},
"isDraft": {
"type": "boolean",
"location": "query"
}
},
"httpMethod": "POST",
"request": {
"$ref": "Page"
},
"parameterOrder": [
"blogId"
],
"scopes": [
"https://www.googleapis.com/auth/blogger"
]
},
"get": {
"parameters": {
"pageId": {
"required": true,
"location": "path",
"type": "string"
},
"view": {
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
],
"location": "query",
"type": "string"
},
"blogId": {
"location": "path",
"required": true,
"type": "string"
}
},
"id": "blogger.pages.get",
"parameterOrder": [
"blogId",
"pageId"
],
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"httpMethod": "GET",
"response": {
"$ref": "Page"
},
"flatPath": "v3/blogs/{blogId}/pages/{pageId}",
"description": "Gets a page by blog id and page id.",
"path": "v3/blogs/{blogId}/pages/{pageId}"
},
"patch": {
"response": {
"$ref": "Page"
},
"request": {
"$ref": "Page"
},
"httpMethod": "PATCH",
"description": "Patches a page.",
"id": "blogger.pages.patch",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"flatPath": "v3/blogs/{blogId}/pages/{pageId}",
"parameters": {
"blogId": {
"required": true,
"type": "string",
"location": "path"
},
"publish": {
"location": "query",
"type": "boolean"
},
"pageId": {
"type": "string",
"required": true,
"location": "path"
},
"revert": {
"location": "query",
"type": "boolean"
}
},
"parameterOrder": [
"blogId",
"pageId"
],
"path": "v3/blogs/{blogId}/pages/{pageId}"
},
"revert": {
"id": "blogger.pages.revert",
"parameterOrder": [
"blogId",
"pageId"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/blogger"
],
"parameters": {
"blogId": {
"location": "path",
"required": true,
"type": "string"
},
"pageId": {
"required": true,
"location": "path",
"type": "string"
}
},
"response": {
"$ref": "Page"
},
"path": "v3/blogs/{blogId}/pages/{pageId}/revert",
"flatPath": "v3/blogs/{blogId}/pages/{pageId}/revert",
"description": "Reverts a published or scheduled page to draft state."
}
}
},
"blogs": {
"methods": {
"getByUrl": {
"parameterOrder": [
"url"
],
"response": {
"$ref": "Blog"
},
"parameters": {
"view": {
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
],
"type": "string",
"location": "query"
},
"url": {
"location": "query",
"required": true,
"type": "string"
}
},
"id": "blogger.blogs.getByUrl",
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"flatPath": "v3/blogs/byurl",
"path": "v3/blogs/byurl",
"description": "Gets a blog by url.",
"httpMethod": "GET"
},
"get": {
"httpMethod": "GET",
"parameters": {
"maxPosts": {
"type": "integer",
"format": "uint32",
"location": "query"
},
"view": {
"enumDescriptions": [
"",
"",
"",
""
],
"location": "query",
"type": "string",
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
]
},
"blogId": {
"required": true,
"type": "string",
"location": "path"
}
},
"path": "v3/blogs/{blogId}",
"description": "Gets a blog by id.",
"id": "blogger.blogs.get",
"flatPath": "v3/blogs/{blogId}",
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"response": {
"$ref": "Blog"
},
"parameterOrder": [
"blogId"
]
},
"listByUser": {
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"path": "v3/users/{userId}/blogs",
"httpMethod": "GET",
"response": {
"$ref": "BlogList"
},
"parameters": {
"status": {
"repeated": true,
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string",
"enum": [
"LIVE",
"DELETED"
],
"description": "Default value of status is LIVE."
},
"view": {
"enumDescriptions": [
"",
"",
"",
""
],
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
],
"type": "string",
"location": "query"
},
"userId": {
"type": "string",
"required": true,
"location": "path"
},
"role": {
"enum": [
"VIEW_TYPE_UNSPECIFIED",
"READER",
"AUTHOR",
"ADMIN"
],
"location": "query",
"repeated": true,
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"fetchUserInfo": {
"type": "boolean",
"location": "query"
}
},
"id": "blogger.blogs.listByUser",
"description": "Lists blogs by user.",
"parameterOrder": [
"userId"
],
"flatPath": "v3/users/{userId}/blogs"
}
}
},
"users": {
"methods": {
"get": {
"response": {
"$ref": "User"
},
"httpMethod": "GET",
"parameters": {
"userId": {
"location": "path",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/blogger",
"https://www.googleapis.com/auth/blogger.readonly"
],
"path": "v3/users/{userId}",
"parameterOrder": [
"userId"
],
"flatPath": "v3/users/{userId}",
"description": "Gets one user by user_id.",
"id": "blogger.users.get"
}
}
}
},
"ownerDomain": "google.com",
"mtlsRootUrl": "https://blogger.mtls.googleapis.com/",
"baseUrl": "https://blogger.googleapis.com/",
"name": "blogger",
"title": "Blogger API v3",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"revision": "20200801"
}