class Google::Apis::SiteVerificationV1::SiteVerificationService
Google
Site Verification API
Verifies ownership of websites or domains with Google
.
@example
require 'google/apis/site_verification_v1' SiteVerification = Google::Apis::SiteVerificationV1 # Alias the module service = SiteVerification::SiteVerificationService.new
Attributes
@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.
@return [String]
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
@return [String]
Deprecated. Please use quotaUser instead.
Public Class Methods
# File lib/google/apis/site_verification_v1/service.rb, line 49 def initialize super('https://www.googleapis.com/', 'siteVerification/v1/', client_name: 'google-apis-site_verification_v1', client_version: Google::Apis::SiteVerificationV1::GEM_VERSION) @batch_path = 'batch/siteVerification/v1' end
Public Instance Methods
Relinquish ownership of a website or domain. @param [String] id
The id of a verified site or domain.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
@param [String] user_ip
Deprecated. Please use quotaUser instead.
@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/site_verification_v1/service.rb, line 78 def delete_web_resource(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'webResource/{id}', options) command.params['id'] = id unless id.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 the most current data for a website or domain. @param [String] id
The id of a verified site or domain.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
@param [String] user_ip
Deprecated. Please use quotaUser instead.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource]
@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/site_verification_v1/service.rb, line 109 def get_web_resource(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'webResource/{id}', options) command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource command.params['id'] = id unless id.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 a verification token for placing on a website or domain. @param [Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest] get_web_resource_token_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
@param [String] user_ip
Deprecated. Please use quotaUser instead.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse]
@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/site_verification_v1/service.rb, line 141 def get_web_resource_token(get_web_resource_token_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'token', options) command.request_representation = Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest::Representation command.request_object = get_web_resource_token_request_object command.response_representation = Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse::Representation command.response_class = Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse 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
Attempt verification of a website or domain. @param [String] verification_method
The method to use for verifying a site or domain.
@param [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] site_verification_web_resource_resource_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
@param [String] user_ip
Deprecated. Please use quotaUser instead.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource]
@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/site_verification_v1/service.rb, line 176 def insert_web_resource(verification_method, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'webResource', options) command.request_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.request_object = site_verification_web_resource_resource_object command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource command.query['verificationMethod'] = verification_method unless verification_method.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 the list of your verified websites and domains. @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
@param [String] user_ip
Deprecated. Please use quotaUser instead.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::SiteVerificationV1::ListWebResourceResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::SiteVerificationV1::ListWebResourceResponse]
@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/site_verification_v1/service.rb, line 209 def list_web_resources(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'webResource', options) command.response_representation = Google::Apis::SiteVerificationV1::ListWebResourceResponse::Representation command.response_class = Google::Apis::SiteVerificationV1::ListWebResourceResponse 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
Modify the list of owners for your website or domain. This method supports patch semantics. @param [String] id
The id of a verified site or domain.
@param [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] site_verification_web_resource_resource_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
@param [String] user_ip
Deprecated. Please use quotaUser instead.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource]
@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/site_verification_v1/service.rb, line 243 def patch_web_resource(id, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'webResource/{id}', options) command.request_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.request_object = site_verification_web_resource_resource_object command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource command.params['id'] = id unless id.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
Modify the list of owners for your website or domain. @param [String] id
The id of a verified site or domain.
@param [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] site_verification_web_resource_resource_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
@param [String] user_ip
Deprecated. Please use quotaUser instead.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource]
@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/site_verification_v1/service.rb, line 279 def update_web_resource(id, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'webResource/{id}', options) command.request_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.request_object = site_verification_web_resource_resource_object command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource command.params['id'] = id unless id.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
Protected Instance Methods
# File lib/google/apis/site_verification_v1/service.rb, line 294 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? end