View Source GoogleApi.Blogger.V3.Api.Pages (google_api_blogger v0.15.0)
API calls for all endpoints tagged Pages
.
Summary
Functions
Deletes a page by blog id and page id.
Gets a page by blog id and page id.
Patches a page.
Publishes a page.
Reverts a published or scheduled page to draft state.
Updates a page by blog id and page id.
Functions
Link to this function
blogger_pages_delete(connection, blog_id, page_id, optional_params \\ [], opts \\ [])
View Source@spec blogger_pages_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a page by blog id and page id.
Parameters
-
connection
(type:GoogleApi.Blogger.V3.Connection.t
) - Connection to server -
blog_id
(type:String.t
) - -
page_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"). -
:useTrash
(type:boolean()
) - Move to Trash if possible
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
Link to this function
blogger_pages_get(connection, blog_id, page_id, optional_params \\ [], opts \\ [])
View Source@spec blogger_pages_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Blogger.V3.Model.Page.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a page by blog id and page id.
Parameters
-
connection
(type:GoogleApi.Blogger.V3.Connection.t
) - Connection to server -
blog_id
(type:String.t
) - -
page_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"). -
:view
(type:String.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Blogger.V3.Model.Page{}}
on success -
{:error, info}
on failure
Link to this function
blogger_pages_insert(connection, blog_id, optional_params \\ [], opts \\ [])
View Source@spec blogger_pages_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Blogger.V3.Model.Page.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Inserts a page.
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"). -
:isDraft
(type:boolean()
) - -
:body
(type:GoogleApi.Blogger.V3.Model.Page.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Blogger.V3.Model.Page{}}
on success -
{:error, info}
on failure
Link to this function
blogger_pages_list(connection, blog_id, optional_params \\ [], opts \\ [])
View Source@spec blogger_pages_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Blogger.V3.Model.PageList.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists pages.
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"). -
:fetchBodies
(type:boolean()
) - -
:maxResults
(type:integer()
) - -
:pageToken
(type:String.t
) - -
:status
(type:list(String.t)
) - -
:view
(type:String.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Blogger.V3.Model.PageList{}}
on success -
{:error, info}
on failure
Link to this function
blogger_pages_patch(connection, blog_id, page_id, optional_params \\ [], opts \\ [])
View Source@spec blogger_pages_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Blogger.V3.Model.Page.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Patches a page.
Parameters
-
connection
(type:GoogleApi.Blogger.V3.Connection.t
) - Connection to server -
blog_id
(type:String.t
) - -
page_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"). -
:publish
(type:boolean()
) - -
:revert
(type:boolean()
) - -
:body
(type:GoogleApi.Blogger.V3.Model.Page.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Blogger.V3.Model.Page{}}
on success -
{:error, info}
on failure
Link to this function
blogger_pages_publish(connection, blog_id, page_id, optional_params \\ [], opts \\ [])
View Source@spec blogger_pages_publish( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Blogger.V3.Model.Page.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Publishes a page.
Parameters
-
connection
(type:GoogleApi.Blogger.V3.Connection.t
) - Connection to server -
blog_id
(type:String.t
) - -
page_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.Page{}}
on success -
{:error, info}
on failure
Link to this function
blogger_pages_revert(connection, blog_id, page_id, optional_params \\ [], opts \\ [])
View Source@spec blogger_pages_revert( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Blogger.V3.Model.Page.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Reverts a published or scheduled page to draft state.
Parameters
-
connection
(type:GoogleApi.Blogger.V3.Connection.t
) - Connection to server -
blog_id
(type:String.t
) - -
page_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.Page{}}
on success -
{:error, info}
on failure
Link to this function
blogger_pages_update(connection, blog_id, page_id, optional_params \\ [], opts \\ [])
View Source@spec blogger_pages_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Blogger.V3.Model.Page.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a page by blog id and page id.
Parameters
-
connection
(type:GoogleApi.Blogger.V3.Connection.t
) - Connection to server -
blog_id
(type:String.t
) - -
page_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"). -
:publish
(type:boolean()
) - -
:revert
(type:boolean()
) - -
:body
(type:GoogleApi.Blogger.V3.Model.Page.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Blogger.V3.Model.Page{}}
on success -
{:error, info}
on failure