google_api_webmaster v0.0.1 GoogleApi.Webmaster.V3.Api.Sites 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
webmasters_sites_add(Tesla.Env.client, String.t, keyword) :: {:ok, nil} | {:error, Tesla.Env.t}
Adds a site to the set of the user's sites in Search Console.
Parameters
- connection (GoogleApi.Webmaster.V3.Connection): Connection to server
- site_url (String): The URL of the site to add.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %{}} on success {:error, info} on failure
webmasters_sites_delete(Tesla.Env.client, String.t, keyword) :: {:ok, nil} | {:error, Tesla.Env.t}
Removes a site from the set of the user's Search Console sites.
Parameters
- connection (GoogleApi.Webmaster.V3.Connection): Connection to server
- site_url (String): The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %{}} on success {:error, info} on failure
webmasters_sites_get(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.Webmaster.V3.Model.WmxSite.t} | {:error, Tesla.Env.t}
Retrieves information about specific site.
Parameters
- connection (GoogleApi.Webmaster.V3.Connection): Connection to server
- site_url (String): The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %GoogleApi.Webmaster.V3.Model.WmxSite{}} on success {:error, info} on failure
webmasters_sites_list(Tesla.Env.client, keyword) :: {:ok, GoogleApi.Webmaster.V3.Model.SitesListResponse.t} | {:error, Tesla.Env.t}
Lists the user's Search Console sites.
Parameters
- connection (GoogleApi.Webmaster.V3.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): 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. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %GoogleApi.Webmaster.V3.Model.SitesListResponse{}} on success {:error, info} on failure