View Source GoogleApi.SearchConsole.V1.Api.Sitemaps (google_api_search_console v0.19.0)

API calls for all endpoints tagged Sitemaps.

Summary

Functions

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

Deletes a sitemap from the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap.

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.

Functions

Link to this function

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

View Source 
@spec 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 the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap.

Parameters

  • connection (type: GoogleApi.SearchConsole.V1.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
    • :"$.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_sitemaps_get(connection, site_url, feedpath, optional_params \\ [], opts \\ [])

View Source 
@spec webmasters_sitemaps_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SearchConsole.V1.Model.WmxSitemap.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves information about a specific sitemap.

Parameters

  • connection (type: GoogleApi.SearchConsole.V1.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
    • :"$.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.WmxSitemap{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec webmasters_sitemaps_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.SearchConsole.V1.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.SearchConsole.V1.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
    • :"$.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").
    • :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.SearchConsole.V1.Model.SitemapsListResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec 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.SearchConsole.V1.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
    • :"$.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