google_api_blogger v0.2.0 GoogleApi.Blogger.V3.Api.Pages View Source
API calls for all endpoints tagged Pages
.
Link to this section Summary
Functions
Delete a page by ID.
Gets one blog page by ID.
Retrieves the pages for a blog, optionally including non-LIVE statuses.
Update a page. This method supports patch semantics.
Publishes a draft page.
Revert a published or scheduled page to draft state.
Link to this section Functions
blogger_pages_delete(connection, blog_id, page_id, optional_params \\ [], opts \\ []) View Source
Delete a page by ID.
Parameters
- connection (GoogleApi.Blogger.V3.Connection): Connection to server
- blog_id (String.t): The ID of the Blog.
- page_id (String.t): The ID of the Page.
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
blogger_pages_get(connection, blog_id, page_id, optional_params \\ [], opts \\ []) View Source
Gets one blog page by ID.
Parameters
- connection (GoogleApi.Blogger.V3.Connection): Connection to server
- blog_id (String.t): ID of the blog containing the page.
- page_id (String.t): The ID of the page 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):
Returns
{:ok, %GoogleApi.Blogger.V3.Model.Page{}} on success {:error, info} on failure
blogger_pages_insert(connection, blog_id, optional_params \\ [], opts \\ []) View Source
Add a page.
Parameters
- connection (GoogleApi.Blogger.V3.Connection): Connection to server
- blog_id (String.t): ID of the blog to add the page to.
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.
- :isDraft (boolean()): Whether to create the page as a draft (default: false).
- :body (Page):
Returns
{:ok, %GoogleApi.Blogger.V3.Model.Page{}} on success {:error, info} on failure
blogger_pages_list(connection, blog_id, optional_params \\ [], opts \\ []) View Source
Retrieves the pages for a blog, optionally including non-LIVE statuses.
Parameters
- connection (GoogleApi.Blogger.V3.Connection): Connection to server
- blog_id (String.t): ID of the blog to fetch Pages 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.
- :fetchBodies (boolean()): Whether to retrieve the Page bodies.
- :maxResults (integer()): Maximum number of Pages to fetch.
- :pageToken (String.t): Continuation token if the request is paged.
- :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.PageList{}} on success {:error, info} on failure
blogger_pages_patch(connection, blog_id, page_id, optional_params \\ [], opts \\ []) View Source
Update a page. This method supports patch semantics.
Parameters
- connection (GoogleApi.Blogger.V3.Connection): Connection to server
- blog_id (String.t): The ID of the Blog.
- page_id (String.t): The ID of the Page.
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.
- :publish (boolean()): Whether a publish action should be performed when the page is updated (default: false).
- :revert (boolean()): Whether a revert action should be performed when the page is updated (default: false).
- :body (Page):
Returns
{:ok, %GoogleApi.Blogger.V3.Model.Page{}} on success {:error, info} on failure
blogger_pages_publish(connection, blog_id, page_id, optional_params \\ [], opts \\ []) View Source
Publishes a draft page.
Parameters
- connection (GoogleApi.Blogger.V3.Connection): Connection to server
- blog_id (String.t): The ID of the blog.
- page_id (String.t): The ID of the page.
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.Page{}} on success {:error, info} on failure
blogger_pages_revert(connection, blog_id, page_id, optional_params \\ [], opts \\ []) View Source
Revert a published or scheduled page to draft state.
Parameters
- connection (GoogleApi.Blogger.V3.Connection): Connection to server
- blog_id (String.t): The ID of the blog.
- page_id (String.t): The ID of the page.
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.Page{}} on success {:error, info} on failure
blogger_pages_update(connection, blog_id, page_id, optional_params \\ [], opts \\ []) View Source
Update a page.
Parameters
- connection (GoogleApi.Blogger.V3.Connection): Connection to server
- blog_id (String.t): The ID of the Blog.
- page_id (String.t): The ID of the Page.
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.
- :publish (boolean()): Whether a publish action should be performed when the page is updated (default: false).
- :revert (boolean()): Whether a revert action should be performed when the page is updated (default: false).
- :body (Page):
Returns
{:ok, %GoogleApi.Blogger.V3.Model.Page{}} on success {:error, info} on failure