class Google::Apis::SearchconsoleV1::SearchConsoleService

Google Search Console API

The Search Console API provides access to both Search Console data (verified

users only) and to public information on an URL basis (anyone)

@example

require 'google/apis/searchconsole_v1'

Searchconsole = Google::Apis::SearchconsoleV1 # Alias the module
service = Searchconsole::SearchConsoleService.new

@see developers.google.com/webmaster-tools/search-console-api/

Attributes

key[RW]

@return [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.
quota_user[RW]

@return [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.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/searchconsole_v1/service.rb, line 46
def initialize
  super('https://searchconsole.googleapis.com/', '',
        client_name: 'google-apis-searchconsole_v1',
        client_version: Google::Apis::SearchconsoleV1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

add_site(site_url, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Adds a site to the set of the user's sites in Search Console. @param [String] site_url

The URL of the site to add.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/searchconsole_v1/service.rb, line 245
def add_site(site_url, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'webmasters/v3/sites/{siteUrl}', options)
  command.params['siteUrl'] = site_url unless site_url.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_site(site_url, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Removes a site from the set of the user's Search Console sites. @param [String] site_url

The URI of the property as defined in Search Console. **Examples:** `http://
www.example.com/` or `sc-domain:example.com`.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/searchconsole_v1/service.rb, line 274
def delete_site(site_url, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'webmasters/v3/sites/{siteUrl}', options)
  command.params['siteUrl'] = site_url unless site_url.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
delete_sitemap(site_url, feedpath, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes a sitemap from this site. @param [String] site_url

The site's URL, including protocol. For example: `http://www.example.com/`.

@param [String] feedpath

The URL of the actual sitemap. For example: `http://www.example.com/sitemap.
xml`.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/searchconsole_v1/service.rb, line 114
def delete_sitemap(site_url, feedpath, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}', options)
  command.params['siteUrl'] = site_url unless site_url.nil?
  command.params['feedpath'] = feedpath unless feedpath.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_site(site_url, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves information about specific site. @param [String] site_url

The URI of the property as defined in Search Console. **Examples:** `http://
www.example.com/` or `sc-domain:example.com`.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::SearchconsoleV1::WmxSite] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SearchconsoleV1::WmxSite]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/searchconsole_v1/service.rb, line 303
def get_site(site_url, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'webmasters/v3/sites/{siteUrl}', options)
  command.response_representation = Google::Apis::SearchconsoleV1::WmxSite::Representation
  command.response_class = Google::Apis::SearchconsoleV1::WmxSite
  command.params['siteUrl'] = site_url unless site_url.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_sitemap(site_url, feedpath, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Retrieves information about a specific sitemap. @param [String] site_url

The site's URL, including protocol. For example: `http://www.example.com/`.

@param [String] feedpath

The URL of the actual sitemap. For example: `http://www.example.com/sitemap.
xml`.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::SearchconsoleV1::WmxSitemap] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SearchconsoleV1::WmxSitemap]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/searchconsole_v1/service.rb, line 146
def get_sitemap(site_url, feedpath, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}', options)
  command.response_representation = Google::Apis::SearchconsoleV1::WmxSitemap::Representation
  command.response_class = Google::Apis::SearchconsoleV1::WmxSitemap
  command.params['siteUrl'] = site_url unless site_url.nil?
  command.params['feedpath'] = feedpath unless feedpath.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_sitemaps(site_url, sitemap_index: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists the [sitemaps-entries](/webmaster-tools/v3/sitemaps) submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the request). @param [String] site_url

The site's URL, including protocol. For example: `http://www.example.com/`.

@param [String] sitemap_index

A URL of a site's sitemap index. For example: `http://www.example.com/
sitemapindex.xml`.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::SearchconsoleV1::SitemapsListResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SearchconsoleV1::SitemapsListResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/searchconsole_v1/service.rb, line 182
def list_sitemaps(site_url, sitemap_index: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'webmasters/v3/sites/{siteUrl}/sitemaps', options)
  command.response_representation = Google::Apis::SearchconsoleV1::SitemapsListResponse::Representation
  command.response_class = Google::Apis::SearchconsoleV1::SitemapsListResponse
  command.params['siteUrl'] = site_url unless site_url.nil?
  command.query['sitemapIndex'] = sitemap_index unless sitemap_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_sites(fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists the user's Search Console sites. @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::SearchconsoleV1::SitesListResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SearchconsoleV1::SitesListResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/searchconsole_v1/service.rb, line 331
def list_sites(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'webmasters/v3/sites', options)
  command.response_representation = Google::Apis::SearchconsoleV1::SitesListResponse::Representation
  command.response_class = Google::Apis::SearchconsoleV1::SitesListResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
query_searchanalytic(site_url, search_analytics_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned. @param [String] site_url

The site's URL, including protocol. For example: `http://www.example.com/`.

@param [Google::Apis::SearchconsoleV1::SearchAnalyticsQueryRequest] search_analytics_query_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::SearchconsoleV1::SearchAnalyticsQueryResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SearchconsoleV1::SearchAnalyticsQueryResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/searchconsole_v1/service.rb, line 79
def query_searchanalytic(site_url, search_analytics_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'webmasters/v3/sites/{siteUrl}/searchAnalytics/query', options)
  command.request_representation = Google::Apis::SearchconsoleV1::SearchAnalyticsQueryRequest::Representation
  command.request_object = search_analytics_query_request_object
  command.response_representation = Google::Apis::SearchconsoleV1::SearchAnalyticsQueryResponse::Representation
  command.response_class = Google::Apis::SearchconsoleV1::SearchAnalyticsQueryResponse
  command.params['siteUrl'] = site_url unless site_url.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
run_mobile_friendly_test(run_mobile_friendly_test_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Runs Mobile-Friendly Test for a given URL. @param [Google::Apis::SearchconsoleV1::RunMobileFriendlyTestRequest] run_mobile_friendly_test_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::SearchconsoleV1::RunMobileFriendlyTestResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SearchconsoleV1::RunMobileFriendlyTestResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/searchconsole_v1/service.rb, line 359
def run_mobile_friendly_test(run_mobile_friendly_test_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/urlTestingTools/mobileFriendlyTest:run', options)
  command.request_representation = Google::Apis::SearchconsoleV1::RunMobileFriendlyTestRequest::Representation
  command.request_object = run_mobile_friendly_test_request_object
  command.response_representation = Google::Apis::SearchconsoleV1::RunMobileFriendlyTestResponse::Representation
  command.response_class = Google::Apis::SearchconsoleV1::RunMobileFriendlyTestResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
submit_sitemap(site_url, feedpath, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Submits a sitemap for a site. @param [String] site_url

The site's URL, including protocol. For example: `http://www.example.com/`.

@param [String] feedpath

The URL of the actual sitemap. For example: `http://www.example.com/sitemap.
xml`.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed

@return [void]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/searchconsole_v1/service.rb, line 216
def submit_sitemap(site_url, feedpath, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}', options)
  command.params['siteUrl'] = site_url unless site_url.nil?
  command.params['feedpath'] = feedpath unless feedpath.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/searchconsole_v1/service.rb, line 372
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end