google_api_webmaster

v0.2.0

google_api_webmaster v0.2.0 GoogleApi.Webmaster.V3.Api.Urlcrawlerrorssamples View Source

API calls for all endpoints tagged Urlcrawlerrorssamples.

Link to this section Summary

Functions

webmasters_urlcrawlerrorssamples_get(connection, site_url, url, category, platform, optional_params \\ [], opts \\ [])

Retrieves details about crawl errors for a site's sample URL

webmasters_urlcrawlerrorssamples_list(connection, site_url, category, platform, optional_params \\ [], opts \\ [])

Lists a site's sample URLs for the specified crawl error category and platform

webmasters_urlcrawlerrorssamples_mark_as_fixed(connection, site_url, url, category, platform, optional_params \\ [], opts \\ [])

Marks the provided site's sample URL as fixed, and removes it from the samples list

Link to this section Functions

Link to this function webmasters_urlcrawlerrorssamples_get(connection, site_url, url, category, platform, optional_params \\ [], opts \\ []) View Source

Retrieves details about crawl errors for a site's sample URL.

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/
  • url (String.t): The relative path (without the site) of the sample URL. It must be one of the URLs returned by list(). For example, for the URL https://www.example.com/pagename on the site https://www.example.com/, the url value is pagename
  • category (String.t): The crawl error category. For example: authPermissions
  • platform (String.t): The user agent type (platform) that made the request. For example: web

  • 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.UrlCrawlErrorsSample{}} on success {:error, info} on failure

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

Lists a site's sample URLs for the specified crawl error category and platform.

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/
  • category (String.t): The crawl error category. For example: authPermissions
  • platform (String.t): The user agent type (platform) that made the request. For example: web

  • 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.UrlCrawlErrorsSamplesListResponse{}} on success {:error, info} on failure

Link to this function webmasters_urlcrawlerrorssamples_mark_as_fixed(connection, site_url, url, category, platform, optional_params \\ [], opts \\ []) View Source

Marks the provided site's sample URL as fixed, and removes it from the samples list.

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/
  • url (String.t): The relative path (without the site) of the sample URL. It must be one of the URLs returned by list(). For example, for the URL https://www.example.com/pagename on the site https://www.example.com/, the url value is pagename
  • category (String.t): The crawl error category. For example: authPermissions
  • platform (String.t): The user agent type (platform) that made the request. For example: web

  • 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