google_api_blogger

v0.13.0

google_api_blogger v0.13.0 GoogleApi.Blogger.V3.Api.Posts View Source

API calls for all endpoints tagged Posts.

Link to this section Summary

Functions

blogger_posts_delete(connection, blog_id, post_id, optional_params \\ [], opts \\ [])

Deletes a post by blog id and post id.

blogger_posts_get(connection, blog_id, post_id, optional_params \\ [], opts \\ [])

Gets a post by blog id and post id

blogger_posts_get_by_path(connection, blog_id, path, optional_params \\ [], opts \\ [])

Gets a post by path.

blogger_posts_insert(connection, blog_id, optional_params \\ [], opts \\ [])

Inserts a post.

blogger_posts_list(connection, blog_id, optional_params \\ [], opts \\ [])

Lists posts.

blogger_posts_patch(connection, blog_id, post_id, optional_params \\ [], opts \\ [])

Patches a post.

blogger_posts_publish(connection, blog_id, post_id, optional_params \\ [], opts \\ [])

Publishes a post.

blogger_posts_revert(connection, blog_id, post_id, optional_params \\ [], opts \\ [])

Reverts a published or scheduled post to draft state.

blogger_posts_search(connection, blog_id, q, optional_params \\ [], opts \\ [])

Searches for posts matching given query terms in the specified blog.

blogger_posts_update(connection, blog_id, post_id, optional_params \\ [], opts \\ [])

Updates a post by blog id and post id.

Link to this section Functions

Link to this function

blogger_posts_delete(connection, blog_id, post_id, optional_params \\ [], opts \\ [])

View Source

Specs

blogger_posts_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Deletes a post by blog id and post id.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) -
  • post_id (type: String.t) -
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

blogger_posts_get(connection, blog_id, post_id, optional_params \\ [], opts \\ [])

View Source

Specs

blogger_posts_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Blogger.V3.Model.Post.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a post by blog id and post id

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) -
  • post_id (type: String.t) -
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :fetchBody (type: boolean()) -
    • :fetchImages (type: boolean()) -
    • :maxComments (type: integer()) -
    • :view (type: String.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.Post{}} on success
  • {:error, info} on failure
Link to this function

blogger_posts_get_by_path(connection, blog_id, path, optional_params \\ [], opts \\ [])

View Source

Specs

blogger_posts_get_by_path(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Blogger.V3.Model.Post.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a post by path.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) -
  • path (type: String.t) -
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :maxComments (type: integer()) -
    • :view (type: String.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.Post{}} on success
  • {:error, info} on failure
Link to this function

blogger_posts_insert(connection, blog_id, optional_params \\ [], opts \\ [])

View Source

Specs

blogger_posts_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Blogger.V3.Model.Post.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Inserts a post.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) -
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :fetchBody (type: boolean()) -
    • :fetchImages (type: boolean()) -
    • :isDraft (type: boolean()) -
    • :body (type: GoogleApi.Blogger.V3.Model.Post.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.Post{}} on success
  • {:error, info} on failure
Link to this function

blogger_posts_list(connection, blog_id, optional_params \\ [], opts \\ [])

View Source

Specs

blogger_posts_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Blogger.V3.Model.PostList.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists posts.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) -
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :endDate (type: String.t) -
    • :fetchBodies (type: boolean()) -
    • :fetchImages (type: boolean()) -
    • :labels (type: String.t) -
    • :maxResults (type: integer()) -
    • :orderBy (type: String.t) -
    • :pageToken (type: String.t) -
    • :startDate (type: String.t) -
    • :status (type: list(String.t)) -
    • :view (type: String.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.PostList{}} on success
  • {:error, info} on failure
Link to this function

blogger_posts_patch(connection, blog_id, post_id, optional_params \\ [], opts \\ [])

View Source

Specs

blogger_posts_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Blogger.V3.Model.Post.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Patches a post.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) -
  • post_id (type: String.t) -
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :fetchBody (type: boolean()) -
    • :fetchImages (type: boolean()) -
    • :maxComments (type: integer()) -
    • :publish (type: boolean()) -
    • :revert (type: boolean()) -
    • :body (type: GoogleApi.Blogger.V3.Model.Post.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.Post{}} on success
  • {:error, info} on failure
Link to this function

blogger_posts_publish(connection, blog_id, post_id, optional_params \\ [], opts \\ [])

View Source

Specs

blogger_posts_publish(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Blogger.V3.Model.Post.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Publishes a post.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) -
  • post_id (type: String.t) -
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :publishDate (type: String.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.Post{}} on success
  • {:error, info} on failure
Link to this function

blogger_posts_revert(connection, blog_id, post_id, optional_params \\ [], opts \\ [])

View Source

Specs

blogger_posts_revert(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Blogger.V3.Model.Post.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Reverts a published or scheduled post to draft state.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) -
  • post_id (type: String.t) -
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.Post{}} on success
  • {:error, info} on failure
Link to this function

blogger_posts_search(connection, blog_id, q, optional_params \\ [], opts \\ [])

View Source

Specs

blogger_posts_search(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Blogger.V3.Model.PostList.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Searches for posts matching given query terms in the specified blog.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) -
  • q (type: String.t) -
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :fetchBodies (type: boolean()) -
    • :orderBy (type: String.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.PostList{}} on success
  • {:error, info} on failure
Link to this function

blogger_posts_update(connection, blog_id, post_id, optional_params \\ [], opts \\ [])

View Source

Specs

blogger_posts_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Blogger.V3.Model.Post.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates a post by blog id and post id.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • blog_id (type: String.t) -
  • post_id (type: String.t) -
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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 (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :fetchBody (type: boolean()) -
    • :fetchImages (type: boolean()) -
    • :maxComments (type: integer()) -
    • :publish (type: boolean()) -
    • :revert (type: boolean()) -
    • :body (type: GoogleApi.Blogger.V3.Model.Post.t) -
  • opts (type: keyword()) - Call options

Returns

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