Class: Google::Apis::WebmastersV3::WebmastersService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::WebmastersV3::WebmastersService
- Defined in:
- generated/google/apis/webmasters_v3/service.rb
Overview
Search Console API
View Google Search Console data for your verified sites.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
-
#user_ip ⇒ String
IP address of the site where the request originates.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#add_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Adds a site to the set of the user's sites in Search Console.
-
#delete_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Removes a site from the set of the user's Search Console sites.
-
#delete_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes a sitemap from this site.
-
#get_errors_sample(site_url, url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::UrlCrawlErrorsSample
Retrieves details about crawl errors for a site's sample URL.
-
#get_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::WmxSite
Retrieves information about specific site.
-
#get_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::WmxSitemap
Retrieves information about a specific sitemap.
-
#initialize ⇒ WebmastersService
constructor
A new instance of WebmastersService.
-
#list_errors_samples(site_url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::ListUrlCrawlErrorsSamplesResponse
Lists a site's sample URLs for the specified crawl error category and platform.
-
#list_sitemaps(site_url, sitemap_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::ListSitemapsResponse
Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).
-
#list_sites(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::ListSitesResponse
Lists the user's Search Console sites.
-
#mark_as_fixed(site_url, url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Marks the provided site's sample URL as fixed, and removes it from the samples list.
-
#query_errors_count(site_url, category: nil, latest_counts_only: nil, platform: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::QueryUrlCrawlErrorsCountsResponse
Retrieves a time series of the number of URL crawl errors per error category and platform.
-
#query_search_analytics(site_url, search_analytics_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::SearchAnalyticsQueryResponse
Query your data with filters and parameters that you define.
-
#submit_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Submits a sitemap for a site.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Constructor Details
#initialize ⇒ WebmastersService
Returns a new instance of WebmastersService.
51 52 53 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 51 def initialize super('https://www.googleapis.com/', 'webmasters/v3/') end |
Instance Attribute Details
#key ⇒ String
Returns 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.
38 39 40 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns 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.
44 45 46 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 44 def quota_user @quota_user end |
#user_ip ⇒ String
Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.
49 50 51 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 49 def user_ip @user_ip end |
Instance Method Details
#add_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Adds a site to the set of the user's sites in Search Console.
273 274 275 276 277 278 279 280 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 273 def add_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'sites/{siteUrl}', ) 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#delete_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Removes a site from the set of the user's Search Console sites.
307 308 309 310 311 312 313 314 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 307 def delete_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'sites/{siteUrl}', ) 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#delete_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Deletes a sitemap from this site.
125 126 127 128 129 130 131 132 133 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 125 def delete_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'sites/{siteUrl}/sitemaps/{feedpath}', ) 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_errors_sample(site_url, url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::UrlCrawlErrorsSample
Retrieves details about crawl errors for a site's sample URL.
463 464 465 466 467 468 469 470 471 472 473 474 475 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 463 def get_errors_sample(site_url, url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites/{siteUrl}/urlCrawlErrorsSamples/{url}', ) command.response_representation = Google::Apis::WebmastersV3::UrlCrawlErrorsSample::Representation command.response_class = Google::Apis::WebmastersV3::UrlCrawlErrorsSample command.params['siteUrl'] = site_url unless site_url.nil? command.params['url'] = url unless url.nil? command.query['category'] = category unless category.nil? command.query['platform'] = platform unless platform.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::WmxSite
Retrieves information about specific site.
341 342 343 344 345 346 347 348 349 350 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 341 def get_site(site_url, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites/{siteUrl}', ) command.response_representation = Google::Apis::WebmastersV3::WmxSite::Representation command.response_class = Google::Apis::WebmastersV3::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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::WmxSitemap
Retrieves information about a specific sitemap.
161 162 163 164 165 166 167 168 169 170 171 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 161 def get_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites/{siteUrl}/sitemaps/{feedpath}', ) command.response_representation = Google::Apis::WebmastersV3::WmxSitemap::Representation command.response_class = Google::Apis::WebmastersV3::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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_errors_samples(site_url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::ListUrlCrawlErrorsSamplesResponse
Lists a site's sample URLs for the specified crawl error category and platform.
505 506 507 508 509 510 511 512 513 514 515 516 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 505 def list_errors_samples(site_url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites/{siteUrl}/urlCrawlErrorsSamples', ) command.response_representation = Google::Apis::WebmastersV3::ListUrlCrawlErrorsSamplesResponse::Representation command.response_class = Google::Apis::WebmastersV3::ListUrlCrawlErrorsSamplesResponse command.params['siteUrl'] = site_url unless site_url.nil? command.query['category'] = category unless category.nil? command.query['platform'] = platform unless platform.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_sitemaps(site_url, sitemap_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::ListSitemapsResponse
Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).
201 202 203 204 205 206 207 208 209 210 211 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 201 def list_sitemaps(site_url, sitemap_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites/{siteUrl}/sitemaps', ) command.response_representation = Google::Apis::WebmastersV3::ListSitemapsResponse::Representation command.response_class = Google::Apis::WebmastersV3::ListSitemapsResponse 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_sites(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::ListSitesResponse
Lists the user's Search Console sites.
374 375 376 377 378 379 380 381 382 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 374 def list_sites(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites', ) command.response_representation = Google::Apis::WebmastersV3::ListSitesResponse::Representation command.response_class = Google::Apis::WebmastersV3::ListSitesResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#mark_as_fixed(site_url, url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Marks the provided site's sample URL as fixed, and removes it from the samples list.
551 552 553 554 555 556 557 558 559 560 561 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 551 def mark_as_fixed(site_url, url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'sites/{siteUrl}/urlCrawlErrorsSamples/{url}', ) command.params['siteUrl'] = site_url unless site_url.nil? command.params['url'] = url unless url.nil? command.query['category'] = category unless category.nil? command.query['platform'] = platform unless platform.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#query_errors_count(site_url, category: nil, latest_counts_only: nil, platform: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::QueryUrlCrawlErrorsCountsResponse
Retrieves a time series of the number of URL crawl errors per error category and platform.
417 418 419 420 421 422 423 424 425 426 427 428 429 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 417 def query_errors_count(site_url, category: nil, latest_counts_only: nil, platform: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'sites/{siteUrl}/urlCrawlErrorsCounts/query', ) command.response_representation = Google::Apis::WebmastersV3::QueryUrlCrawlErrorsCountsResponse::Representation command.response_class = Google::Apis::WebmastersV3::QueryUrlCrawlErrorsCountsResponse command.params['siteUrl'] = site_url unless site_url.nil? command.query['category'] = category unless category.nil? command.query['latestCountsOnly'] = latest_counts_only unless latest_counts_only.nil? command.query['platform'] = platform unless platform.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#query_search_analytics(site_url, search_analytics_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebmastersV3::SearchAnalyticsQueryResponse
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.
86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 86 def query_search_analytics(site_url, search_analytics_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'sites/{siteUrl}/searchAnalytics/query', ) command.request_representation = Google::Apis::WebmastersV3::SearchAnalyticsQueryRequest::Representation command.request_object = search_analytics_query_request_object command.response_representation = Google::Apis::WebmastersV3::SearchAnalyticsQueryResponse::Representation command.response_class = Google::Apis::WebmastersV3::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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#submit_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Submits a sitemap for a site.
239 240 241 242 243 244 245 246 247 |
# File 'generated/google/apis/webmasters_v3/service.rb', line 239 def submit_sitemap(site_url, feedpath, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'sites/{siteUrl}/sitemaps/{feedpath}', ) 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |