GoogleApi.SearchConsole.V1.Api.Sites (google_api_search_console v0.16.0) View Source
API calls for all endpoints tagged Sites
.
Link to this section Summary
Functions
Adds a site to the set of the user's sites in Search Console.
Removes a site from the set of the user's Search Console sites.
Retrieves information about specific site.
Lists the user's Search Console sites.
Link to this section Functions
Link to this function
webmasters_sites_add(connection, site_url, optional_params \\ [], opts \\ [])
View SourceSpecs
webmasters_sites_add(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Adds a site to the set of the user's sites in Search Console.
Parameters
-
connection
(type:GoogleApi.SearchConsole.V1.Connection.t
) - Connection to server -
site_url
(type:String.t
) - The URL of the site to add. -
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
webmasters_sites_delete(connection, site_url, optional_params \\ [], opts \\ [])
View SourceSpecs
webmasters_sites_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Removes a site from the set of the user's Search Console sites.
Parameters
-
connection
(type:GoogleApi.SearchConsole.V1.Connection.t
) - Connection to server -
site_url
(type:String.t
) - The URI of the property as defined in Search Console. Examples:http://www.example.com/
orsc-domain:example.com
. -
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
webmasters_sites_get(connection, site_url, optional_params \\ [], opts \\ [])
View SourceSpecs
webmasters_sites_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.SearchConsole.V1.Model.WmxSite.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves information about specific site.
Parameters
-
connection
(type:GoogleApi.SearchConsole.V1.Connection.t
) - Connection to server -
site_url
(type:String.t
) - The URI of the property as defined in Search Console. Examples:http://www.example.com/
orsc-domain:example.com
. -
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.SearchConsole.V1.Model.WmxSite{}}
on success -
{:error, info}
on failure
Link to this function
webmasters_sites_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
webmasters_sites_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.SearchConsole.V1.Model.SitesListResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the user's Search Console sites.
Parameters
-
connection
(type:GoogleApi.SearchConsole.V1.Connection.t
) - Connection to server -
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.SearchConsole.V1.Model.SitesListResponse{}}
on success -
{:error, info}
on failure