google_api_blogger v0.11.1 GoogleApi.Blogger.V3.Api.Blogs View Source

API calls for all endpoints tagged Blogs.

Link to this section Summary

Functions

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

Gets a blog by id.

blogger_blogs_get_by_url(connection, url, optional_params \\ [], opts \\ [])

Gets a blog by url.

blogger_blogs_list_by_user(connection, user_id, optional_params \\ [], opts \\ [])

Lists blogs by user.

Link to this section Functions

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

Specs

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

Gets a blog by id.

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").
- :maxPosts (type: integer()) -
- :view (type: String.t) -
opts (type: keyword()) - Call options

Returns

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

blogger_blogs_get_by_url(connection, url, optional_params \\ [], opts \\ [])

Specs

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

Gets a blog by url.

Parameters

connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
url (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").
- :view (type: String.t) -
opts (type: keyword()) - Call options

Returns

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

blogger_blogs_list_by_user(connection, user_id, optional_params \\ [], opts \\ [])

Specs

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

Lists blogs by user.

Parameters

connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
user_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").
- :fetchUserInfo (type: boolean()) -
- :role (type: list(String.t)) -
- :status (type: list(String.t)) - Default value of status is LIVE.
- :view (type: String.t) -
opts (type: keyword()) - Call options

Returns

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