google_api_webmaster v0.0.1 GoogleApi.Webmaster.V3.Api.Sitemaps View Source

API calls for all endpoints tagged Sitemaps.

Link to this section Summary

Functions

Retrieves information about a specific sitemap

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

Link to this section Functions

Link to this function webmasters_sitemaps_delete(connection, site_url, feedpath, opts \\ []) View Source
webmasters_sitemaps_delete(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, nil} |
  {:error, Tesla.Env.t}

Deletes a sitemap from this site.

Parameters

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

Link to this function webmasters_sitemaps_get(connection, site_url, feedpath, opts \\ []) View Source
webmasters_sitemaps_get(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Webmaster.V3.Model.WmxSitemap.t} |
  {:error, Tesla.Env.t}

Retrieves information about a specific sitemap.

Parameters

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

Link to this function webmasters_sitemaps_list(connection, site_url, opts \\ []) View Source
webmasters_sitemaps_list(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.Webmaster.V3.Model.SitemapsListResponse.t} |
  {:error, Tesla.Env.t}

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

Parameters

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

Returns

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

Link to this function webmasters_sitemaps_submit(connection, site_url, feedpath, opts \\ []) View Source
webmasters_sitemaps_submit(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, nil} |
  {:error, Tesla.Env.t}

Submits a sitemap for a site.

Parameters

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