google_api_webmaster v0.14.0

GoogleApi.Webmaster.V3.Api.Sites (google_api_webmaster v0.14.0) View Source

API calls for all endpoints tagged Sites.

Link to this section Summary

Functions

webmasters_sites_add(connection, site_url, optional_params \\ [], opts \\ [])

Adds a site to the set of the user's sites in Search Console.

webmasters_sites_delete(connection, site_url, optional_params \\ [], opts \\ [])

Removes a site from the set of the user's Search Console sites.

webmasters_sites_get(connection, site_url, optional_params \\ [], opts \\ [])

Retrieves information about specific site.

webmasters_sites_list(connection, optional_params \\ [], opts \\ [])

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 Source

Specs

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.Webmaster.V3.Connection.t) - Connection to server
  • site_url (type: String.t) - The URL of the site to add.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • 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 Source

Specs

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.Webmaster.V3.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/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • 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 Source

Specs

webmasters_sites_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Webmaster.V3.Model.WmxSite.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves information about specific site.

Parameters

  • connection (type: GoogleApi.Webmaster.V3.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/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Webmaster.V3.Model.WmxSite{}} on success
  • {:error, info} on failure
Link to this function

webmasters_sites_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

webmasters_sites_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Webmaster.V3.Model.SitesListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the user's Search Console sites.

Parameters

  • connection (type: GoogleApi.Webmaster.V3.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Webmaster.V3.Model.SitesListResponse{}} on success
  • {:error, info} on failure