google_api_blogger v0.2.0 GoogleApi.Blogger.V3.Api.Comments View Source

API calls for all endpoints tagged Comments.

Link to this section Summary

Link to this section Functions

Link to this function

blogger_comments_approve(connection, blog_id, post_id, comment_id, optional_params \\ [], opts \\ []) View Source

Marks a comment as not spam.

Parameters

  • connection (GoogleApi.Blogger.V3.Connection): Connection to server
  • blog_id (String.t): The ID of the Blog.
  • post_id (String.t): The ID of the Post.
  • comment_id (String.t): The ID of the comment to mark as not spam.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %GoogleApi.Blogger.V3.Model.Comment{}} on success {:error, info} on failure

Link to this function

blogger_comments_delete(connection, blog_id, post_id, comment_id, optional_params \\ [], opts \\ []) View Source

Delete a comment by ID.

Parameters

  • connection (GoogleApi.Blogger.V3.Connection): Connection to server
  • blog_id (String.t): The ID of the Blog.
  • post_id (String.t): The ID of the Post.
  • comment_id (String.t): The ID of the comment to delete.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

blogger_comments_get(connection, blog_id, post_id, comment_id, optional_params \\ [], opts \\ []) View Source

Gets one comment by ID.

Parameters

  • connection (GoogleApi.Blogger.V3.Connection): Connection to server
  • blog_id (String.t): ID of the blog to containing the comment.
  • post_id (String.t): ID of the post to fetch posts from.
  • comment_id (String.t): The ID of the comment to get.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :view (String.t): 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.

Returns

{:ok, %GoogleApi.Blogger.V3.Model.Comment{}} on success {:error, info} on failure

Link to this function

blogger_comments_list(connection, blog_id, post_id, optional_params \\ [], opts \\ []) View Source

Retrieves the comments for a post, possibly filtered.

Parameters

  • connection (GoogleApi.Blogger.V3.Connection): Connection to server
  • blog_id (String.t): ID of the blog to fetch comments from.
  • post_id (String.t): ID of the post to fetch posts from.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :endDate (DateTime.t): Latest date of comment to fetch, a date-time with RFC 3339 formatting.
    • :fetchBodies (boolean()): Whether the body content of the comments is included.
    • :maxResults (integer()): Maximum number of comments to include in the result.
    • :pageToken (String.t): Continuation token if request is paged.
    • :startDate (DateTime.t): Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
    • :status ([String.t]):
    • :view (String.t): Access level with which to view the returned result. Note that some fields require elevated access.

Returns

{:ok, %GoogleApi.Blogger.V3.Model.CommentList{}} on success {:error, info} on failure

Link to this function

blogger_comments_list_by_blog(connection, blog_id, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.Blogger.V3.Connection): Connection to server
  • blog_id (String.t): ID of the blog to fetch comments from.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :endDate (DateTime.t): Latest date of comment to fetch, a date-time with RFC 3339 formatting.
    • :fetchBodies (boolean()): Whether the body content of the comments is included.
    • :maxResults (integer()): Maximum number of comments to include in the result.
    • :pageToken (String.t): Continuation token if request is paged.
    • :startDate (DateTime.t): Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
    • :status ([String.t]):

Returns

{:ok, %GoogleApi.Blogger.V3.Model.CommentList{}} on success {:error, info} on failure

Link to this function

blogger_comments_mark_as_spam(connection, blog_id, post_id, comment_id, optional_params \\ [], opts \\ []) View Source

Marks a comment as spam.

Parameters

  • connection (GoogleApi.Blogger.V3.Connection): Connection to server
  • blog_id (String.t): The ID of the Blog.
  • post_id (String.t): The ID of the Post.
  • comment_id (String.t): The ID of the comment to mark as spam.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %GoogleApi.Blogger.V3.Model.Comment{}} on success {:error, info} on failure

Link to this function

blogger_comments_remove_content(connection, blog_id, post_id, comment_id, optional_params \\ [], opts \\ []) View Source

Removes the content of a comment.

Parameters

  • connection (GoogleApi.Blogger.V3.Connection): Connection to server
  • blog_id (String.t): The ID of the Blog.
  • post_id (String.t): The ID of the Post.
  • comment_id (String.t): The ID of the comment to delete content from.
  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %GoogleApi.Blogger.V3.Model.Comment{}} on success {:error, info} on failure