Class: Google::Apis::SafebrowsingV4::SafebrowsingService

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

Overview

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.

Examples:

require 'google/apis/safebrowsing_v4'

Safebrowsing = Google::Apis::SafebrowsingV4 # Alias the module
service = Safebrowsing::SafebrowsingService.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

#initializeSafebrowsingService

Returns a new instance of SafebrowsingService.


49
50
51
52
# File 'generated/google/apis/safebrowsing_v4/service.rb', line 49

def initialize
  super('https://safebrowsing.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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.


42
43
44
# File 'generated/google/apis/safebrowsing_v4/service.rb', line 42

def key
  @key
end

#quota_userString

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.


47
48
49
# File 'generated/google/apis/safebrowsing_v4/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

#create_threat_hit(threat_hit_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SafebrowsingV4::Empty

Reports a Safe Browsing threat list hit to Google. Only projects with TRUSTED_REPORTER visibility can use this method.

Parameters:

  • threat_hit_object (Google::Apis::SafebrowsingV4::ThreatHit) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


178
179
180
181
182
183
184
185
186
187
# File 'generated/google/apis/safebrowsing_v4/service.rb', line 178

def create_threat_hit(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::ThreatHit::Representation
  command.request_object = threat_hit_object
  command.response_representation = Google::Apis::SafebrowsingV4::Empty::Representation
  command.response_class = Google::Apis::SafebrowsingV4::Empty
  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(fetch_threat_list_updates_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SafebrowsingV4::FetchThreatListUpdatesResponse

Fetches the most recent threat list updates. A client can request updates for multiple lists at once.

Parameters:

  • fetch_threat_list_updates_request_object (Google::Apis::SafebrowsingV4::FetchThreatListUpdatesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


209
210
211
212
213
214
215
216
217
218
# File 'generated/google/apis/safebrowsing_v4/service.rb', line 209

def fetch_threat_list_updates(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::FetchThreatListUpdatesRequest::Representation
  command.request_object = fetch_threat_list_updates_request_object
  command.response_representation = Google::Apis::SafebrowsingV4::FetchThreatListUpdatesResponse::Representation
  command.response_class = Google::Apis::SafebrowsingV4::FetchThreatListUpdatesResponse
  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(find_full_hashes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SafebrowsingV4::FindFullHashesResponse

Finds the full hashes that match the requested hash prefixes.

Parameters:

  • find_full_hashes_request_object (Google::Apis::SafebrowsingV4::FindFullHashesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


147
148
149
150
151
152
153
154
155
156
# File 'generated/google/apis/safebrowsing_v4/service.rb', line 147

def find_full_hashes(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::FindFullHashesRequest::Representation
  command.request_object = find_full_hashes_request_object
  command.response_representation = Google::Apis::SafebrowsingV4::FindFullHashesResponse::Representation
  command.response_class = Google::Apis::SafebrowsingV4::FindFullHashesResponse
  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(find_threat_matches_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SafebrowsingV4::FindThreatMatchesResponse

Finds the threat entries that match the Safe Browsing lists.

Parameters:

  • find_threat_matches_request_object (Google::Apis::SafebrowsingV4::FindThreatMatchesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


266
267
268
269
270
271
272
273
274
275
# File 'generated/google/apis/safebrowsing_v4/service.rb', line 266

def find_threat_matches(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::FindThreatMatchesRequest::Representation
  command.request_object = find_threat_matches_request_object
  command.response_representation = Google::Apis::SafebrowsingV4::FindThreatMatchesResponse::Representation
  command.response_class = Google::Apis::SafebrowsingV4::FindThreatMatchesResponse
  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) {|result, err| ... } ⇒ Google::Apis::SafebrowsingV4::FindFullHashesResponse

Parameters:

  • encoded_request (String)

    A serialized FindFullHashesRequest proto.

  • client_id (String) (defaults to: nil)

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

  • client_version (String) (defaults to: nil)

    The version of the client implementation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


79
80
81
82
83
84
85
86
87
88
89
# File 'generated/google/apis/safebrowsing_v4/service.rb', line 79

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::FindFullHashesResponse::Representation
  command.response_class = Google::Apis::SafebrowsingV4::FindFullHashesResponse
  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) {|result, err| ... } ⇒ Google::Apis::SafebrowsingV4::FetchThreatListUpdatesResponse

Parameters:

  • encoded_request (String)

    A serialized FetchThreatListUpdatesRequest proto.

  • client_id (String) (defaults to: nil)

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

  • client_version (String) (defaults to: nil)

    The version of the client implementation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


116
117
118
119
120
121
122
123
124
125
126
# File 'generated/google/apis/safebrowsing_v4/service.rb', line 116

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::FetchThreatListUpdatesResponse::Representation
  command.response_class = Google::Apis::SafebrowsingV4::FetchThreatListUpdatesResponse
  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) {|result, err| ... } ⇒ Google::Apis::SafebrowsingV4::ListThreatListsResponse

Lists the Safe Browsing threat lists available for download.

Parameters:

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


238
239
240
241
242
243
244
245
# File 'generated/google/apis/safebrowsing_v4/service.rb', line 238

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::ListThreatListsResponse::Representation
  command.response_class = Google::Apis::SafebrowsingV4::ListThreatListsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end