google_api_blogger v0.2.0 GoogleApi.Blogger.V3.Api.Blogs View Source
API calls for all endpoints tagged Blogs.
Link to this section Summary
Functions
Gets one blog by ID.
Retrieve a Blog by URL.
Retrieves a list of blogs, possibly filtered.
Link to this section Functions
Link to this function
blogger_blogs_get(connection, blog_id, optional_params \\ [], opts \\ []) View Source
Gets one blog by ID.
Parameters
- connection (GoogleApi.Blogger.V3.Connection): Connection to server
- blog_id (String.t): The ID of the blog 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.
- :maxPosts (integer()): Maximum number of posts to pull back with the blog.
- :view (String.t): Access level with which to view the blog. Note that some fields require elevated access.
Returns
{:ok, %GoogleApi.Blogger.V3.Model.Blog{}} on success {:error, info} on failure
Link to this function
blogger_blogs_get_by_url(connection, url, optional_params \\ [], opts \\ []) View Source
Retrieve a Blog by URL.
Parameters
- connection (GoogleApi.Blogger.V3.Connection): Connection to server
- url (String.t): The URL of the blog to retrieve.
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 with which to view the blog. Note that some fields require elevated access.
Returns
{:ok, %GoogleApi.Blogger.V3.Model.Blog{}} on success {:error, info} on failure
Link to this function
blogger_blogs_list_by_user(connection, user_id, optional_params \\ [], opts \\ []) View Source
Retrieves a list of blogs, possibly filtered.
Parameters
- connection (GoogleApi.Blogger.V3.Connection): Connection to server
- user_id (String.t): ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier.
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.
- :fetchUserInfo (boolean()): Whether the response is a list of blogs with per-user information instead of just blogs.
- :role ([String.t]): User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles.
- :status ([String.t]): Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs.
- :view (String.t): Access level with which to view the blogs. Note that some fields require elevated access.
Returns
{:ok, %GoogleApi.Blogger.V3.Model.BlogList{}} on success {:error, info} on failure