google_api_webmaster

v0.2.0

google_api_webmaster v0.2.0 GoogleApi.Webmaster.V3.Api.Sitemaps 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

Link to this function webmasters_sitemaps_delete(connection, site_url, feedpath, optional_params \\ [], opts \\ []) View Source

Deletes a sitemap from this site.

Parameters

  • connection (GoogleApi.Webmaster.V3.Connection): Connection to server
  • site_url (String.t): The site's URL, including protocol. For example: http://www.example.com/
  • feedpath (String.t): The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml

  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function webmasters_sitemaps_get(connection, site_url, feedpath, optional_params \\ [], opts \\ []) View Source

Retrieves information about a specific sitemap.

Parameters

  • connection (GoogleApi.Webmaster.V3.Connection): Connection to server
  • site_url (String.t): The site's URL, including protocol. For example: http://www.example.com/
  • feedpath (String.t): The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml

  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

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

Link to this function webmasters_sitemaps_list(connection, site_url, optional_params \\ [], opts \\ []) View Source

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.t): The site's URL, including protocol. For example: http://www.example.com/

  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :sitemapIndex (String.t): 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, optional_params \\ [], opts \\ []) View Source

Submits a sitemap for a site.

Parameters

  • connection (GoogleApi.Webmaster.V3.Connection): Connection to server
  • site_url (String.t): The site's URL, including protocol. For example: http://www.example.com/
  • feedpath (String.t): The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml

  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure