class Google::Apis::SafebrowsingV4::SafebrowsingService

Safe Browsing API

Enables client applications to check web resources (most commonly URLs)

against Google-generated lists of unsafe web resources. The Safe Browsing APIs
are for non-commercial use only. If you need to use APIs to detect malicious
URLs for commercial purposes – meaning “for sale or revenue-generating
purposes” – please refer to the Web Risk API.

@example

require 'google/apis/safebrowsing_v4'

Safebrowsing = Google::Apis::SafebrowsingV4 # Alias the module
service = Safebrowsing::SafebrowsingService.new

@see developers.google.com/safe-browsing/

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/safebrowsing_v4/service.rb, line 49
def initialize
  super('https://safebrowsing.googleapis.com/', '',
        client_name: 'google-apis-safebrowsing_v4',
        client_version: Google::Apis::SafebrowsingV4::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

create_threat_hit(google_security_safebrowsing_v4_threat_hit_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Reports a Safe Browsing threat list hit to Google. Only projects with TRUSTED_REPORTER visibility can use this method. @param [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatHit] google_security_safebrowsing_v4_threat_hit_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::SafebrowsingV4::GoogleProtobufEmpty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SafebrowsingV4::GoogleProtobufEmpty]

@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/safebrowsing_v4/service.rb, line 180
def create_threat_hit(google_security_safebrowsing_v4_threat_hit_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/threatHits', options)
  command.request_representation = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatHit::Representation
  command.request_object = google_security_safebrowsing_v4_threat_hit_object
  command.response_representation = Google::Apis::SafebrowsingV4::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::SafebrowsingV4::GoogleProtobufEmpty
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
fetch_threat_list_updates(google_security_safebrowsing_v4_fetch_threat_list_updates_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Fetches the most recent threat list updates. A client can request updates for multiple lists at once. @param [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequest] google_security_safebrowsing_v4_fetch_threat_list_updates_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::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse]

@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/safebrowsing_v4/service.rb, line 211
def fetch_threat_list_updates(google_security_safebrowsing_v4_fetch_threat_list_updates_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/threatListUpdates:fetch', options)
  command.request_representation = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequest::Representation
  command.request_object = google_security_safebrowsing_v4_fetch_threat_list_updates_request_object
  command.response_representation = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse::Representation
  command.response_class = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
find_full_hashes(google_security_safebrowsing_v4_find_full_hashes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Finds the full hashes that match the requested hash prefixes. @param [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindFullHashesRequest] google_security_safebrowsing_v4_find_full_hashes_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::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindFullHashesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindFullHashesResponse]

@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/safebrowsing_v4/service.rb, line 149
def find_full_hashes(google_security_safebrowsing_v4_find_full_hashes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/fullHashes:find', options)
  command.request_representation = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindFullHashesRequest::Representation
  command.request_object = google_security_safebrowsing_v4_find_full_hashes_request_object
  command.response_representation = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindFullHashesResponse::Representation
  command.response_class = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindFullHashesResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
find_threat_matches(google_security_safebrowsing_v4_find_threat_matches_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Finds the threat entries that match the Safe Browsing lists. @param [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindThreatMatchesRequest] google_security_safebrowsing_v4_find_threat_matches_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::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindThreatMatchesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindThreatMatchesResponse]

@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/safebrowsing_v4/service.rb, line 268
def find_threat_matches(google_security_safebrowsing_v4_find_threat_matches_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/threatMatches:find', options)
  command.request_representation = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindThreatMatchesRequest::Representation
  command.request_object = google_security_safebrowsing_v4_find_threat_matches_request_object
  command.response_representation = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindThreatMatchesResponse::Representation
  command.response_class = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindThreatMatchesResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
get_encoded_full_hash(encoded_request, client_id: nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

@param [String] encoded_request

A serialized FindFullHashesRequest proto.

@param [String] client_id

A client ID that (hopefully) uniquely identifies the client implementation of
the Safe Browsing API.

@param [String] client_version

The version of the client implementation.

@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::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindFullHashesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindFullHashesResponse]

@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/safebrowsing_v4/service.rb, line 81
def get_encoded_full_hash(encoded_request, client_id: nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/encodedFullHashes/{encodedRequest}', options)
  command.response_representation = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindFullHashesResponse::Representation
  command.response_class = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FindFullHashesResponse
  command.params['encodedRequest'] = encoded_request unless encoded_request.nil?
  command.query['clientId'] = client_id unless client_id.nil?
  command.query['clientVersion'] = client_version unless client_version.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_encoded_update(encoded_request, client_id: nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

@param [String] encoded_request

A serialized FetchThreatListUpdatesRequest proto.

@param [String] client_id

A client ID that uniquely identifies the client implementation of the Safe
Browsing API.

@param [String] client_version

The version of the client implementation.

@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::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse]

@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/safebrowsing_v4/service.rb, line 118
def get_encoded_update(encoded_request, client_id: nil, client_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/encodedUpdates/{encodedRequest}', options)
  command.response_representation = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse::Representation
  command.response_class = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse
  command.params['encodedRequest'] = encoded_request unless encoded_request.nil?
  command.query['clientId'] = client_id unless client_id.nil?
  command.query['clientVersion'] = client_version unless client_version.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_threat_lists(fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists the Safe Browsing threat lists available for download. @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::SafebrowsingV4::GoogleSecuritySafebrowsingV4ListThreatListsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ListThreatListsResponse]

@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/safebrowsing_v4/service.rb, line 240
def list_threat_lists(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/threatLists', options)
  command.response_representation = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ListThreatListsResponse::Representation
  command.response_class = Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ListThreatListsResponse
  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/safebrowsing_v4/service.rb, line 281
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end