google_api_blogger v0.0.1 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, opts \\ []) View Source
blogger_comments_approve(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Blogger.V3.Model.Comment.t} |
  {:error, Tesla.Env.t}

Marks a comment as not spam.

Parameters

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

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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, opts \\ []) View Source
blogger_comments_delete(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, nil} |
  {:error, Tesla.Env.t}

Delete a comment by ID.

Parameters

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

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

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

Link to this function blogger_comments_get(connection, blog_id, post_id, comment_id, opts \\ []) View Source
blogger_comments_get(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Blogger.V3.Model.Comment.t} |
  {:error, Tesla.Env.t}

Gets one comment by ID.

Parameters

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

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :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.

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, opts \\ []) View Source
blogger_comments_list(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Blogger.V3.Model.CommentList.t} |
  {:error, Tesla.Env.t}

Retrieves the comments for a post, possibly filtered.

Parameters

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

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :end_date (String): Latest date of comment to fetch, a date-time with RFC 3339 formatting.
    • :fetch_bodies (Boolean): Whether the body content of the comments is included.
    • :max_results (Integer): Maximum number of comments to include in the result.
    • :page_token (String): Continuation token if request is paged.
    • :start_date (String): Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
    • :status (List[String]):
    • :view (String): 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, opts \\ []) View Source
blogger_comments_list_by_blog(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.Blogger.V3.Model.CommentList.t} |
  {:error, Tesla.Env.t}

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

Parameters

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

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :end_date (String): Latest date of comment to fetch, a date-time with RFC 3339 formatting.
    • :fetch_bodies (Boolean): Whether the body content of the comments is included.
    • :max_results (Integer): Maximum number of comments to include in the result.
    • :page_token (String): Continuation token if request is paged.
    • :start_date (String): Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
    • :status (List[String]):

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, opts \\ []) View Source
blogger_comments_mark_as_spam(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Blogger.V3.Model.Comment.t} |
  {:error, Tesla.Env.t}

Marks a comment as spam.

Parameters

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

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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, opts \\ []) View Source
blogger_comments_remove_content(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Blogger.V3.Model.Comment.t} |
  {:error, Tesla.Env.t}

Removes the content of a comment.

Parameters

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

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

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