Class: Google::Apis::SearchconsoleV1::SearchConsoleService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/searchconsole_v1/service.rb

Overview

Google Search Console URL Testing Tools API

Provides tools for running validation tests against single URLs

Examples:

require 'google/apis/searchconsole_v1'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ SearchConsoleService

Returns a new instance of SearchConsoleService



45
46
47
48
 
# File 'generated/google/apis/searchconsole_v1/service.rb', line 45

def initialize
  super('https://searchconsole.googleapis.com/', '')
  @batch_path = 'batch'
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.

Returns:

  • (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.



43
44
45
 
# File 'generated/google/apis/searchconsole_v1/service.rb', line 43

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.

Returns:

  • (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.



38
39
40
 
# File 'generated/google/apis/searchconsole_v1/service.rb', line 38

def quota_user
  @quota_user
end

Instance Method Details

#run_mobile_friendly_test(run_mobile_friendly_test_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SearchconsoleV1::RunMobileFriendlyTestResponse

Runs Mobile-Friendly Test for a given URL.

Parameters:

  • run_mobile_friendly_test_request_object (Google::Apis::SearchconsoleV1::RunMobileFriendlyTestRequest) (defaults to: nil)
  • 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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



69
70
71
72
73
74
75
76
77
78
 
# File 'generated/google/apis/searchconsole_v1/service.rb', line 69

def run_mobile_friendly_test(run_mobile_friendly_test_request_object = nil, quota_user: nil, fields: 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['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end