Blogger API . comments

Instance Methods

approve(blogId=*, postId=*, commentId=*)

Marks a comment as not spam.

delete(blogId=*, postId=*, commentId=*)

Delete a comment by ID.

get(blogId=*, postId=*, commentId=*, view=None)

Gets one comment by ID.

list(blogId=*, postId=*, status=None, startDate=None, fetchBodies=None, endDate=None, pageToken=None, maxResults=None, view=None)

Retrieves the comments for a post, possibly filtered.

listByBlog(blogId=*, status=None, startDate=None, endDate=None, pageToken=None, maxResults=None, fetchBodies=None)

Retrieves the comments for a blog, across all posts, possibly filtered.

listByBlog_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

list_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

markAsSpam(blogId=*, postId=*, commentId=*)

Marks a comment as spam.

removeContent(blogId=*, postId=*, commentId=*)

Removes the content of a comment.

Method Details

approve(blogId=*, postId=*, commentId=*)
Marks a comment as not spam.

Args:
  blogId: string, The ID of the Blog. (required)
  postId: string, The ID of the Post. (required)
  commentId: string, The ID of the comment to mark as not spam. (required)

Returns:
  An object of the form:

    {
    "status": "A String", # The status of the comment (only populated for admin users)
    "content": "A String", # The actual content of the comment. May include HTML markup.
    "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
    "inReplyTo": { # Data about the comment this is in reply to.
      "id": "A String", # The identified of the parent of this comment.
    },
    "author": { # The author of this Comment.
      "url": "A String", # The URL of the Comment creator's Profile page.
      "image": { # The comment creator's avatar.
        "url": "A String", # The comment creator's avatar URL.
      },
      "displayName": "A String", # The display name.
      "id": "A String", # The identifier of the Comment creator.
    },
    "updated": "A String", # RFC 3339 date-time when this comment was last updated.
    "blog": { # Data about the blog containing this comment.
      "id": "A String", # The identifier of the blog containing this comment.
    },
    "published": "A String", # RFC 3339 date-time when this comment was published.
    "post": { # Data about the post containing this comment.
      "id": "A String", # The identifier of the post containing this comment.
    },
    "id": "A String", # The identifier for this resource.
    "selfLink": "A String", # The API REST URL to fetch this resource from.
  }
delete(blogId=*, postId=*, commentId=*)
Delete a comment by ID.

Args:
  blogId: string, The ID of the Blog. (required)
  postId: string, The ID of the Post. (required)
  commentId: string, The ID of the comment to delete. (required)
get(blogId=*, postId=*, commentId=*, view=None)
Gets one comment by ID.

Args:
  blogId: string, ID of the blog to containing the comment. (required)
  postId: string, ID of the post to fetch posts from. (required)
  commentId: string, The ID of the comment to get. (required)
  view: string, 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.
    Allowed values
      ADMIN - Admin level detail
      AUTHOR - Author level detail
      READER - Admin level detail

Returns:
  An object of the form:

    {
    "status": "A String", # The status of the comment (only populated for admin users)
    "content": "A String", # The actual content of the comment. May include HTML markup.
    "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
    "inReplyTo": { # Data about the comment this is in reply to.
      "id": "A String", # The identified of the parent of this comment.
    },
    "author": { # The author of this Comment.
      "url": "A String", # The URL of the Comment creator's Profile page.
      "image": { # The comment creator's avatar.
        "url": "A String", # The comment creator's avatar URL.
      },
      "displayName": "A String", # The display name.
      "id": "A String", # The identifier of the Comment creator.
    },
    "updated": "A String", # RFC 3339 date-time when this comment was last updated.
    "blog": { # Data about the blog containing this comment.
      "id": "A String", # The identifier of the blog containing this comment.
    },
    "published": "A String", # RFC 3339 date-time when this comment was published.
    "post": { # Data about the post containing this comment.
      "id": "A String", # The identifier of the post containing this comment.
    },
    "id": "A String", # The identifier for this resource.
    "selfLink": "A String", # The API REST URL to fetch this resource from.
  }
list(blogId=*, postId=*, status=None, startDate=None, fetchBodies=None, endDate=None, pageToken=None, maxResults=None, view=None)
Retrieves the comments for a post, possibly filtered.

Args:
  blogId: string, ID of the blog to fetch comments from. (required)
  postId: string, ID of the post to fetch posts from. (required)
  status: string, A parameter (repeated)
    Allowed values
      emptied - Comments that have had their content removed
      live - Comments that are publicly visible
      pending - Comments that are awaiting administrator approval
      spam - Comments marked as spam by the administrator
  startDate: string, Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
  fetchBodies: boolean, Whether the body content of the comments is included.
  endDate: string, Latest date of comment to fetch, a date-time with RFC 3339 formatting.
  pageToken: string, Continuation token if request is paged.
  maxResults: integer, Maximum number of comments to include in the result.
  view: string, Access level with which to view the returned result. Note that some fields require elevated access.
    Allowed values
      ADMIN - Admin level detail
      AUTHOR - Author level detail
      READER - Reader level detail

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
    "items": [ # The List of Comments for a Post.
      {
        "status": "A String", # The status of the comment (only populated for admin users)
        "content": "A String", # The actual content of the comment. May include HTML markup.
        "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
        "inReplyTo": { # Data about the comment this is in reply to.
          "id": "A String", # The identified of the parent of this comment.
        },
        "author": { # The author of this Comment.
          "url": "A String", # The URL of the Comment creator's Profile page.
          "image": { # The comment creator's avatar.
            "url": "A String", # The comment creator's avatar URL.
          },
          "displayName": "A String", # The display name.
          "id": "A String", # The identifier of the Comment creator.
        },
        "updated": "A String", # RFC 3339 date-time when this comment was last updated.
        "blog": { # Data about the blog containing this comment.
          "id": "A String", # The identifier of the blog containing this comment.
        },
        "published": "A String", # RFC 3339 date-time when this comment was published.
        "post": { # Data about the post containing this comment.
          "id": "A String", # The identifier of the post containing this comment.
        },
        "id": "A String", # The identifier for this resource.
        "selfLink": "A String", # The API REST URL to fetch this resource from.
      },
    ],
    "kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
    "etag": "A String", # Etag of the response.
    "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
  }
listByBlog(blogId=*, status=None, startDate=None, endDate=None, pageToken=None, maxResults=None, fetchBodies=None)
Retrieves the comments for a blog, across all posts, possibly filtered.

Args:
  blogId: string, ID of the blog to fetch comments from. (required)
  status: string, A parameter (repeated)
    Allowed values
      emptied - Comments that have had their content removed
      live - Comments that are publicly visible
      pending - Comments that are awaiting administrator approval
      spam - Comments marked as spam by the administrator
  startDate: string, Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
  endDate: string, Latest date of comment to fetch, a date-time with RFC 3339 formatting.
  pageToken: string, Continuation token if request is paged.
  maxResults: integer, Maximum number of comments to include in the result.
  fetchBodies: boolean, Whether the body content of the comments is included.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
    "items": [ # The List of Comments for a Post.
      {
        "status": "A String", # The status of the comment (only populated for admin users)
        "content": "A String", # The actual content of the comment. May include HTML markup.
        "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
        "inReplyTo": { # Data about the comment this is in reply to.
          "id": "A String", # The identified of the parent of this comment.
        },
        "author": { # The author of this Comment.
          "url": "A String", # The URL of the Comment creator's Profile page.
          "image": { # The comment creator's avatar.
            "url": "A String", # The comment creator's avatar URL.
          },
          "displayName": "A String", # The display name.
          "id": "A String", # The identifier of the Comment creator.
        },
        "updated": "A String", # RFC 3339 date-time when this comment was last updated.
        "blog": { # Data about the blog containing this comment.
          "id": "A String", # The identifier of the blog containing this comment.
        },
        "published": "A String", # RFC 3339 date-time when this comment was published.
        "post": { # Data about the post containing this comment.
          "id": "A String", # The identifier of the post containing this comment.
        },
        "id": "A String", # The identifier for this resource.
        "selfLink": "A String", # The API REST URL to fetch this resource from.
      },
    ],
    "kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
    "etag": "A String", # Etag of the response.
    "prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
  }
listByBlog_next(previous_request=*, previous_response=*)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
list_next(previous_request=*, previous_response=*)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
markAsSpam(blogId=*, postId=*, commentId=*)
Marks a comment as spam.

Args:
  blogId: string, The ID of the Blog. (required)
  postId: string, The ID of the Post. (required)
  commentId: string, The ID of the comment to mark as spam. (required)

Returns:
  An object of the form:

    {
    "status": "A String", # The status of the comment (only populated for admin users)
    "content": "A String", # The actual content of the comment. May include HTML markup.
    "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
    "inReplyTo": { # Data about the comment this is in reply to.
      "id": "A String", # The identified of the parent of this comment.
    },
    "author": { # The author of this Comment.
      "url": "A String", # The URL of the Comment creator's Profile page.
      "image": { # The comment creator's avatar.
        "url": "A String", # The comment creator's avatar URL.
      },
      "displayName": "A String", # The display name.
      "id": "A String", # The identifier of the Comment creator.
    },
    "updated": "A String", # RFC 3339 date-time when this comment was last updated.
    "blog": { # Data about the blog containing this comment.
      "id": "A String", # The identifier of the blog containing this comment.
    },
    "published": "A String", # RFC 3339 date-time when this comment was published.
    "post": { # Data about the post containing this comment.
      "id": "A String", # The identifier of the post containing this comment.
    },
    "id": "A String", # The identifier for this resource.
    "selfLink": "A String", # The API REST URL to fetch this resource from.
  }
removeContent(blogId=*, postId=*, commentId=*)
Removes the content of a comment.

Args:
  blogId: string, The ID of the Blog. (required)
  postId: string, The ID of the Post. (required)
  commentId: string, The ID of the comment to delete content from. (required)

Returns:
  An object of the form:

    {
    "status": "A String", # The status of the comment (only populated for admin users)
    "content": "A String", # The actual content of the comment. May include HTML markup.
    "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
    "inReplyTo": { # Data about the comment this is in reply to.
      "id": "A String", # The identified of the parent of this comment.
    },
    "author": { # The author of this Comment.
      "url": "A String", # The URL of the Comment creator's Profile page.
      "image": { # The comment creator's avatar.
        "url": "A String", # The comment creator's avatar URL.
      },
      "displayName": "A String", # The display name.
      "id": "A String", # The identifier of the Comment creator.
    },
    "updated": "A String", # RFC 3339 date-time when this comment was last updated.
    "blog": { # Data about the blog containing this comment.
      "id": "A String", # The identifier of the blog containing this comment.
    },
    "published": "A String", # RFC 3339 date-time when this comment was published.
    "post": { # Data about the post containing this comment.
      "id": "A String", # The identifier of the post containing this comment.
    },
    "id": "A String", # The identifier for this resource.
    "selfLink": "A String", # The API REST URL to fetch this resource from.
  }