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

API calls for all endpoints tagged Sitemaps.

Link to this section Summary

Functions

webmasters_sitemaps_delete(connection, site_url, feedpath, optional_params \\ [], opts \\ [])

Deletes a sitemap from this site.

webmasters_sitemaps_get(connection, site_url, feedpath, optional_params \\ [], opts \\ [])

Retrieves information about a specific sitemap.

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

Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).

webmasters_sitemaps_submit(connection, site_url, feedpath, optional_params \\ [], opts \\ [])

Submits a sitemap for a site.

Link to this section Functions

webmasters_sitemaps_delete(connection, site_url, feedpath, optional_params \\ [], opts \\ [])

Specs

webmasters_sitemaps_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes a sitemap from this site.

Parameters

connection (type: GoogleApi.Webmaster.V3.Connection.t) - Connection to server
site_url (type: String.t) - The site's URL, including protocol. For example: http://www.example.com/
feedpath (type: String.t) - The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml
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

webmasters_sitemaps_get(connection, site_url, feedpath, optional_params \\ [], opts \\ [])

Specs

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

Retrieves information about a specific sitemap.

Parameters

connection (type: GoogleApi.Webmaster.V3.Connection.t) - Connection to server
site_url (type: String.t) - The site's URL, including protocol. For example: http://www.example.com/
feedpath (type: String.t) - The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml
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.WmxSitemap{}} on success
{:error, info} on failure

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

Specs

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

Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).

Parameters

connection (type: GoogleApi.Webmaster.V3.Connection.t) - Connection to server
site_url (type: String.t) - The site's URL, including protocol. For example: http://www.example.com/
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.
- :sitemapIndex (type: String.t) - A URL of a site's sitemap index. For example: http://www.example.com/sitemapindex.xml
opts (type: keyword()) - Call options

Returns

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

webmasters_sitemaps_submit(connection, site_url, feedpath, optional_params \\ [], opts \\ [])

Specs

webmasters_sitemaps_submit(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Submits a sitemap for a site.

Parameters

connection (type: GoogleApi.Webmaster.V3.Connection.t) - Connection to server
site_url (type: String.t) - The site's URL, including protocol. For example: http://www.example.com/
feedpath (type: String.t) - The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml
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