gogol-blogger-0.0.1: Google Blogger SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Blogger

Contents

Description

API for access to the data within Blogger.

See: Blogger API Reference

Synopsis

Service Configuration

bloggerService :: Service Source

Default request referring to version v3 of the Blogger API. This contains the host and root path used as a starting point for constructing service requests.

API Declaration

Resources

blogger.blogUserInfos.get

blogger.blogs.get

blogger.blogs.getByUrl

blogger.blogs.listByUser

blogger.comments.approve

blogger.comments.delete

blogger.comments.get

blogger.comments.list

blogger.comments.listByBlog

blogger.comments.markAsSpam

blogger.comments.removeContent

blogger.pageViews.get

blogger.pages.delete

blogger.pages.get

blogger.pages.insert

blogger.pages.list

blogger.pages.patch

blogger.pages.publish

blogger.pages.revert

blogger.pages.update

blogger.postUserInfos.get

blogger.postUserInfos.list

blogger.posts.delete

blogger.posts.get

blogger.posts.getByPath

blogger.posts.insert

blogger.posts.list

blogger.posts.patch

blogger.posts.publish

blogger.posts.revert

blogger.posts.search

blogger.posts.update

blogger.users.get

Types

PostsListOrderBy

PostsListView

data PostsListView Source

Access level with which to view the returned result. Note that some fields require escalated access.

Constructors

Admin

ADMIN Admin level detail

Author

AUTHOR Author level detail

Reader

READER Reader level detail

PageViewsGetRange

PostUserInfo

postUserInfo :: PostUserInfo Source

Creates a value of PostUserInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

puiPostUserInfo :: Lens' PostUserInfo (Maybe PostPerUserInfo) Source

Information about a User for the Post.

puiPost :: Lens' PostUserInfo (Maybe Post') Source

The Post resource.

puiKind :: Lens' PostUserInfo Text Source

The kind of this entity. Always blogger#postUserInfo

CommentsListView

PostAuthorImage

postAuthorImage :: PostAuthorImage Source

Creates a value of PostAuthorImage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

paiURL :: Lens' PostAuthorImage (Maybe Text) Source

The Post author's avatar URL.

PostUserInfosListStatus

PostList

postList :: PostList Source

Creates a value of PostList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

plEtag :: Lens' PostList (Maybe Text) Source

Etag of the response.

plNextPageToken :: Lens' PostList (Maybe Text) Source

Pagination token to fetch the next page, if one exists.

plKind :: Lens' PostList Text Source

The kind of this entity. Always blogger#postList

plItems :: Lens' PostList [Post'] Source

The list of Posts for this Blog.

CommentInReplyTo

commentInReplyTo :: CommentInReplyTo Source

Creates a value of CommentInReplyTo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cirtId :: Lens' CommentInReplyTo (Maybe Text) Source

The identified of the parent of this comment.

CommentBlog

commentBlog :: CommentBlog Source

Creates a value of CommentBlog with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cbId :: Lens' CommentBlog (Maybe Text) Source

The identifier of the blog containing this comment.

Pageviews

pageviews :: Pageviews Source

Creates a value of Pageviews with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pKind :: Lens' Pageviews Text Source

The kind of this entry. Always blogger#page_views

pCounts :: Lens' Pageviews [PageviewsCountsItem] Source

The container of posts in this blog.

PostLocation

postLocation :: PostLocation Source

Creates a value of PostLocation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

plSpan :: Lens' PostLocation (Maybe Text) Source

Location's viewport span. Can be used when rendering a map preview.

plLat :: Lens' PostLocation (Maybe Double) Source

Location's latitude.

plLng :: Lens' PostLocation (Maybe Double) Source

Location's longitude.

BlogPosts

blogPosts :: BlogPosts Source

Creates a value of BlogPosts with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bpTotalItems :: Lens' BlogPosts (Maybe Int32) Source

The count of posts in this blog.

bpItems :: Lens' BlogPosts [Post'] Source

The List of Posts for this Blog.

bpSelfLink :: Lens' BlogPosts (Maybe Text) Source

The URL of the container for posts in this blog.

PostsGetView

data PostsGetView Source

Access level with which to view the returned result. Note that some fields require elevated access.

Constructors

PGVAdmin

ADMIN Admin level detail

PGVAuthor

AUTHOR Author level detail

PGVReader

READER Reader level detail

Post'

post :: Post' Source

Creates a value of Post with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

posImages :: Lens' Post' [PostImagesItem] Source

Display image for the Post.

posStatus :: Lens' Post' (Maybe Text) Source

Status of the post. Only set for admin-level requests

posEtag :: Lens' Post' (Maybe Text) Source

Etag of the resource.

posReaderComments :: Lens' Post' (Maybe Text) Source

Comment control and display setting for readers of this post.

posLocation :: Lens' Post' (Maybe PostLocation) Source

The location for geotagged posts.

posKind :: Lens' Post' Text Source

The kind of this entity. Always blogger#post

posPublished :: Lens' Post' (Maybe UTCTime) Source

RFC 3339 date-time when this Post was published.

posURL :: Lens' Post' (Maybe Text) Source

The URL where this Post is displayed.

posBlog :: Lens' Post' (Maybe PostBlog) Source

Data about the blog containing this Post.

posCustomMetaData :: Lens' Post' (Maybe Text) Source

The JSON meta-data for the Post.

posContent :: Lens' Post' (Maybe Text) Source

The content of the Post. May contain HTML markup.

posReplies :: Lens' Post' (Maybe PostReplies) Source

The container of comments on this Post.

posSelfLink :: Lens' Post' (Maybe Text) Source

The API REST URL to fetch this resource from.

posAuthor :: Lens' Post' (Maybe PostAuthor) Source

The author of this Post.

posId :: Lens' Post' (Maybe Text) Source

The identifier of this Post.

posLabels :: Lens' Post' [Text] Source

The list of labels this Post was tagged with.

posUpdated :: Lens' Post' (Maybe UTCTime) Source

RFC 3339 date-time when this Post was last updated.

posTitleLink :: Lens' Post' (Maybe Text) Source

The title link URL, similar to atom's related link.

posTitle :: Lens' Post' (Maybe Text) Source

The title of the Post.

PostsSearchOrderBy

CommentsListByBlogStatus

PagesGetView

PostUserInfosListOrderBy

Page

page :: Page Source

Creates a value of Page with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pagStatus :: Lens' Page (Maybe Text) Source

The status of the page for admin resources (either LIVE or DRAFT).

pagEtag :: Lens' Page (Maybe Text) Source

Etag of the resource.

pagKind :: Lens' Page Text Source

The kind of this entity. Always blogger#page

pagPublished :: Lens' Page (Maybe UTCTime) Source

RFC 3339 date-time when this Page was published.

pagURL :: Lens' Page (Maybe Text) Source

The URL that this Page is displayed at.

pagBlog :: Lens' Page (Maybe PageBlog) Source

Data about the blog containing this Page.

pagContent :: Lens' Page (Maybe Text) Source

The body content of this Page, in HTML.

pagSelfLink :: Lens' Page (Maybe Text) Source

The API REST URL to fetch this resource from.

pagAuthor :: Lens' Page (Maybe PageAuthor) Source

The author of this Page.

pagId :: Lens' Page (Maybe Text) Source

The identifier for this resource.

pagUpdated :: Lens' Page (Maybe UTCTime) Source

RFC 3339 date-time when this Page was last updated.

pagTitle :: Lens' Page (Maybe Text) Source

The title of this entity. This is the name displayed in the Admin user interface.

BlogLocale

blogLocale :: BlogLocale Source

Creates a value of BlogLocale with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

blVariant :: Lens' BlogLocale (Maybe Text) Source

The language variant this blog is authored in.

blCountry :: Lens' BlogLocale (Maybe Text) Source

The country this blog's locale is set to.

blLanguage :: Lens' BlogLocale (Maybe Text) Source

The language this blog is authored in.

PageAuthor

pageAuthor :: PageAuthor Source

Creates a value of PageAuthor with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

paImage :: Lens' PageAuthor (Maybe PageAuthorImage) Source

The page author's avatar.

paURL :: Lens' PageAuthor (Maybe Text) Source

The URL of the Page creator's Profile page.

paId :: Lens' PageAuthor (Maybe Text) Source

The identifier of the Page creator.

BlogsGetView

data BlogsGetView Source

Access level with which to view the blog. Note that some fields require elevated access.

Constructors

BGVAdmin

ADMIN Admin level detail.

BGVAuthor

AUTHOR Author level detail.

BGVReader

READER Reader level detail.

Blog

blog :: Blog Source

Creates a value of Blog with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bStatus :: Lens' Blog (Maybe Text) Source

The status of the blog.

bKind :: Lens' Blog Text Source

The kind of this entry. Always blogger#blog

bPages :: Lens' Blog (Maybe BlogPages) Source

The container of pages in this blog.

bLocale :: Lens' Blog (Maybe BlogLocale) Source

The locale this Blog is set to.

bPublished :: Lens' Blog (Maybe UTCTime) Source

RFC 3339 date-time when this blog was published.

bURL :: Lens' Blog (Maybe Text) Source

The URL where this blog is published.

bCustomMetaData :: Lens' Blog (Maybe Text) Source

The JSON custom meta-data for the Blog

bSelfLink :: Lens' Blog (Maybe Text) Source

The API REST URL to fetch this resource from.

bName :: Lens' Blog (Maybe Text) Source

The name of this blog. This is displayed as the title.

bId :: Lens' Blog (Maybe Text) Source

The identifier for this resource.

bUpdated :: Lens' Blog (Maybe UTCTime) Source

RFC 3339 date-time when this blog was last updated.

bPosts :: Lens' Blog (Maybe BlogPosts) Source

The container of posts in this blog.

bDescription :: Lens' Blog (Maybe Text) Source

The description of this blog. This is displayed underneath the title.

BlogsGetByURLView

CommentsListStatus

BlogPages

blogPages :: BlogPages Source

Creates a value of BlogPages with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bpsTotalItems :: Lens' BlogPages (Maybe Int32) Source

The count of pages in this blog.

bpsSelfLink :: Lens' BlogPages (Maybe Text) Source

The URL of the container for pages in this blog.

PostBlog

data PostBlog Source

Data about the blog containing this Post.

See: postBlog smart constructor.

postBlog :: PostBlog Source

Creates a value of PostBlog with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pbId :: Lens' PostBlog (Maybe Text) Source

The identifier of the Blog that contains this Post.

BlogsListByUserStatus

PageList

pageList :: PageList Source

Creates a value of PageList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pllEtag :: Lens' PageList (Maybe Text) Source

Etag of the response.

pllNextPageToken :: Lens' PageList (Maybe Text) Source

Pagination token to fetch the next page, if one exists.

pllKind :: Lens' PageList Text Source

The kind of this entity. Always blogger#pageList

pllItems :: Lens' PageList [Page] Source

The list of Pages for a Blog.

UserLocale

userLocale :: UserLocale Source

Creates a value of UserLocale with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ulVariant :: Lens' UserLocale (Maybe Text) Source

The user's language variant setting.

ulCountry :: Lens' UserLocale (Maybe Text) Source

The user's country setting.

ulLanguage :: Lens' UserLocale (Maybe Text) Source

The user's language setting.

CommentAuthorImage

commentAuthorImage :: CommentAuthorImage Source

Creates a value of CommentAuthorImage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

caiURL :: Lens' CommentAuthorImage (Maybe Text) Source

The comment creator's avatar URL.

User

user :: User Source

Creates a value of User with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

uBlogs :: Lens' User (Maybe UserBlogs) Source

The container of blogs for this user.

uKind :: Lens' User Text Source

The kind of this entity. Always blogger#user

uCreated :: Lens' User (Maybe UTCTime) Source

The timestamp of when this profile was created, in seconds since epoch.

uLocale :: Lens' User (Maybe UserLocale) Source

This user's locale

uURL :: Lens' User (Maybe Text) Source

The user's profile page.

uSelfLink :: Lens' User (Maybe Text) Source

The API REST URL to fetch this resource from.

uAbout :: Lens' User (Maybe Text) Source

Profile summary information.

uDisplayName :: Lens' User (Maybe Text) Source

The display name.

uId :: Lens' User (Maybe Text) Source

The identifier for this User.

UserBlogs

data UserBlogs Source

The container of blogs for this user.

See: userBlogs smart constructor.

userBlogs :: UserBlogs Source

Creates a value of UserBlogs with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ubSelfLink :: Lens' UserBlogs (Maybe Text) Source

The URL of the Blogs for this user.

PostReplies

postReplies :: PostReplies Source

Creates a value of PostReplies with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

prTotalItems :: Lens' PostReplies (Maybe Int64) Source

The count of comments on this post.

prItems :: Lens' PostReplies [Comment] Source

The List of Comments for this Post.

prSelfLink :: Lens' PostReplies (Maybe Text) Source

The URL of the comments on this post.

BlogList

blogList :: BlogList Source

Creates a value of BlogList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

blKind :: Lens' BlogList Text Source

The kind of this entity. Always blogger#blogList

blItems :: Lens' BlogList [Blog] Source

The list of Blogs this user has Authorship or Admin rights over.

blBlogUserInfos :: Lens' BlogList [BlogUserInfo] Source

Admin level list of blog per-user information

PagesListView

data PagesListView Source

Access level with which to view the returned result. Note that some fields require elevated access.

Constructors

PLVAdmin

ADMIN Admin level detail

PLVAuthor

AUTHOR Author level detail

PLVReader

READER Reader level detail

PageBlog

data PageBlog Source

Data about the blog containing this Page.

See: pageBlog smart constructor.

pageBlog :: PageBlog Source

Creates a value of PageBlog with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pId :: Lens' PageBlog (Maybe Text) Source

The identifier of the blog containing this page.

PostsListStatus

PostAuthor

postAuthor :: PostAuthor Source

Creates a value of PostAuthor with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

paaImage :: Lens' PostAuthor (Maybe PostAuthorImage) Source

The Post author's avatar.

paaURL :: Lens' PostAuthor (Maybe Text) Source

The URL of the Post creator's Profile page.

paaId :: Lens' PostAuthor (Maybe Text) Source

The identifier of the Post creator.

PostPerUserInfo

postPerUserInfo :: PostPerUserInfo Source

Creates a value of PostPerUserInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ppuiKind :: Lens' PostPerUserInfo Text Source

The kind of this entity. Always blogger#postPerUserInfo

ppuiBlogId :: Lens' PostPerUserInfo (Maybe Text) Source

ID of the Blog that the post resource belongs to.

ppuiHasEditAccess :: Lens' PostPerUserInfo (Maybe Bool) Source

True if the user has Author level access to the post.

ppuiPostId :: Lens' PostPerUserInfo (Maybe Text) Source

ID of the Post resource.

BlogsListByUserView

PageviewsCountsItem

pageviewsCountsItem :: PageviewsCountsItem Source

Creates a value of PageviewsCountsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pciTimeRange :: Lens' PageviewsCountsItem (Maybe Text) Source

Time range the given count applies to

pciCount :: Lens' PageviewsCountsItem (Maybe Int64) Source

Count of page views for the given time range

PostUserInfosListView

Comment

comment :: Comment Source

Creates a value of Comment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cStatus :: Lens' Comment (Maybe Text) Source

The status of the comment (only populated for admin users)

cPost :: Lens' Comment (Maybe CommentPost) Source

Data about the post containing this comment.

cKind :: Lens' Comment Text Source

The kind of this entry. Always blogger#comment

cPublished :: Lens' Comment (Maybe UTCTime) Source

RFC 3339 date-time when this comment was published.

cBlog :: Lens' Comment (Maybe CommentBlog) Source

Data about the blog containing this comment.

cContent :: Lens' Comment (Maybe Text) Source

The actual content of the comment. May include HTML markup.

cSelfLink :: Lens' Comment (Maybe Text) Source

The API REST URL to fetch this resource from.

cAuthor :: Lens' Comment (Maybe CommentAuthor) Source

The author of this Comment.

cId :: Lens' Comment (Maybe Text) Source

The identifier for this resource.

cUpdated :: Lens' Comment (Maybe UTCTime) Source

RFC 3339 date-time when this comment was last updated.

cInReplyTo :: Lens' Comment (Maybe CommentInReplyTo) Source

Data about the comment this is in reply to.

CommentsGetView

data CommentsGetView Source

Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation.

Constructors

CGVAdmin

ADMIN Admin level detail

CGVAuthor

AUTHOR Author level detail

CGVReader

READER Admin level detail

CommentPost

commentPost :: CommentPost Source

Creates a value of CommentPost with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cpId :: Lens' CommentPost (Maybe Text) Source

The identifier of the post containing this comment.

PostsGetByPathView

BlogPerUserInfo

blogPerUserInfo :: BlogPerUserInfo Source

Creates a value of BlogPerUserInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bpuiPhotosAlbumKey :: Lens' BlogPerUserInfo (Maybe Text) Source

The Photo Album Key for the user when adding photos to the blog

bpuiKind :: Lens' BlogPerUserInfo Text Source

The kind of this entity. Always blogger#blogPerUserInfo

bpuiBlogId :: Lens' BlogPerUserInfo (Maybe Text) Source

ID of the Blog resource

bpuiRole :: Lens' BlogPerUserInfo (Maybe Text) Source

Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).

bpuiHasAdminAccess :: Lens' BlogPerUserInfo (Maybe Bool) Source

True if the user has Admin level access to the blog.

PostUserInfosList

postUserInfosList :: PostUserInfosList Source

Creates a value of PostUserInfosList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

puilNextPageToken :: Lens' PostUserInfosList (Maybe Text) Source

Pagination token to fetch the next page, if one exists.

puilKind :: Lens' PostUserInfosList Text Source

The kind of this entity. Always blogger#postList

puilItems :: Lens' PostUserInfosList [PostUserInfo] Source

The list of Posts with User information for the post, for this Blog.

PagesListStatus

CommentAuthor

commentAuthor :: CommentAuthor Source

Creates a value of CommentAuthor with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

caImage :: Lens' CommentAuthor (Maybe CommentAuthorImage) Source

The comment creator's avatar.

caURL :: Lens' CommentAuthor (Maybe Text) Source

The URL of the Comment creator's Profile page.

caId :: Lens' CommentAuthor (Maybe Text) Source

The identifier of the Comment creator.

BlogsListByUserRole

data BlogsListByUserRole Source

User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles.

Constructors

BLBURAdmin

ADMIN Admin role - Blogs where the user has Admin level access.

BLBURAuthor

AUTHOR Author role - Blogs where the user has Author level access.

BLBURReader

READER Reader role - Blogs where the user has Reader level access (to a private blog).

BlogUserInfo

blogUserInfo :: BlogUserInfo Source

Creates a value of BlogUserInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

buiKind :: Lens' BlogUserInfo Text Source

The kind of this entity. Always blogger#blogUserInfo

buiBlog :: Lens' BlogUserInfo (Maybe Blog) Source

The Blog resource.

buiBlogUserInfo :: Lens' BlogUserInfo (Maybe BlogPerUserInfo) Source

Information about a User for the Blog.

PageAuthorImage

pageAuthorImage :: PageAuthorImage Source

Creates a value of PageAuthorImage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

pURL :: Lens' PageAuthorImage (Maybe Text) Source

The page author's avatar URL.

CommentList

commentList :: CommentList Source

Creates a value of CommentList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

clEtag :: Lens' CommentList (Maybe Text) Source

Etag of the response.

clNextPageToken :: Lens' CommentList (Maybe Text) Source

Pagination token to fetch the next page, if one exists.

clKind :: Lens' CommentList Text Source

The kind of this entry. Always blogger#commentList

clItems :: Lens' CommentList [Comment] Source

The List of Comments for a Post.

clPrevPageToken :: Lens' CommentList (Maybe Text) Source

Pagination token to fetch the previous page, if one exists.

PostImagesItem

postImagesItem :: PostImagesItem Source

Creates a value of PostImagesItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired: