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

API calls for all endpoints tagged Urlcrawlerrorssamples.

Link to this section Summary

Functions

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

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, opts \\ []) View Source
webmasters_urlcrawlerrorssamples_get(Tesla.Env.client, String.t, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.Webmaster.V3.Model.UrlCrawlErrorsSample.t} |
  {:error, Tesla.Env.t}

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

Parameters

  • connection (GoogleApi.Webmaster.V3.Connection): Connection to server
  • site_url (String): The site's URL, including protocol. For example: http://www.example.com/
  • url (String): 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): The crawl error category. For example: authPermissions
  • platform (String): The user agent type (platform) that made the request. For example: web
  • 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.UrlCrawlErrorsSample{}} on success {:error, info} on failure

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

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): The site's URL, including protocol. For example: http://www.example.com/
  • category (String): The crawl error category. For example: authPermissions
  • platform (String): The user agent type (platform) that made the request. For example: web
  • 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.UrlCrawlErrorsSamplesListResponse{}} on success {:error, info} on failure

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

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): The site's URL, including protocol. For example: http://www.example.com/
  • url (String): 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): The crawl error category. For example: authPermissions
  • platform (String): The user agent type (platform) that made the request. For example: web
  • 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