Class: Google::Apis::SiteVerificationV1::SiteVerificationService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/site_verification_v1/service.rb

Overview

Google Site Verification API

Verifies ownership of websites or domains with Google.

Examples:

require 'google/apis/site_verification_v1'

SiteVerification = Google::Apis::SiteVerificationV1 # Alias the module
service = SiteVerification::SiteVerificationService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://www.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SiteVerificationService

Returns a new instance of SiteVerificationService.



51
52
53
54
55
56
 
# File 'lib/google/apis/site_verification_v1/service.rb', line 51

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, 'siteVerification/v1/',
        client_name: 'google-apis-site_verification_v1',
        client_version: Google::Apis::SiteVerificationV1::GEM_VERSION)
  @batch_path = 'batch/siteVerification/v1'
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.



40
41
42
 
# File 'lib/google/apis/site_verification_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



45
46
47
 
# File 'lib/google/apis/site_verification_v1/service.rb', line 45

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String) —

    Deprecated. Please use quotaUser instead.



49
50
51
 
# File 'lib/google/apis/site_verification_v1/service.rb', line 49

def user_ip
  @user_ip
end

Instance Method Details

#delete_web_resource(id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Relinquish ownership of a website or domain.

Parameters:

  • id (String) —

    The id of a verified site or domain.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



80
81
82
83
84
85
86
87
 
# File 'lib/google/apis/site_verification_v1/service.rb', line 80

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_web_resource(id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource

Get the most current data for a website or domain.

Parameters:

  • id (String) —

    The id of a verified site or domain.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/google/apis/site_verification_v1/service.rb', line 111

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_web_resource_token(get_web_resource_token_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse

Get a verification token for placing on a website or domain.

Parameters:

  • get_web_resource_token_request_object (Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/google/apis/site_verification_v1/service.rb', line 143

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

#insert_web_resource(verification_method, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource

Attempt verification of a website or domain.

Parameters:

  • verification_method (String) —

    The method to use for verifying a site or domain.

  • site_verification_web_resource_resource_object (Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/google/apis/site_verification_v1/service.rb', line 178

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

#list_web_resources(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SiteVerificationV1::ListWebResourceResponse

Get the list of your verified websites and domains.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



211
212
213
214
215
216
217
218
219
 
# File 'lib/google/apis/site_verification_v1/service.rb', line 211

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

#patch_web_resource(id, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource

Modify the list of owners for your website or domain. This method supports patch semantics.

Parameters:

  • id (String) —

    The id of a verified site or domain.

  • site_verification_web_resource_resource_object (Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/google/apis/site_verification_v1/service.rb', line 245

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

#update_web_resource(id, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource

Modify the list of owners for your website or domain.

Parameters:

  • id (String) —

    The id of a verified site or domain.

  • site_verification_web_resource_resource_object (Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String) (defaults to: nil) —

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/google/apis/site_verification_v1/service.rb', line 281

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