Class: Google::Apis::SafebrowsingV4::SafebrowsingService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::SafebrowsingV4::SafebrowsingService
- 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.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#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.
-
#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.
-
#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.
-
#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.
- #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
- #get_encoded_update(encoded_request, client_id: nil, client_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SafebrowsingV4::FetchThreatListUpdatesResponse
-
#initialize ⇒ SafebrowsingService
constructor
A new instance of SafebrowsingService.
-
#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.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ SafebrowsingService
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
#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.
42 43 44 |
# File 'generated/google/apis/safebrowsing_v4/service.rb', line 42 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.
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.
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', ) 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.
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', ) 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.
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', ) 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.
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', ) 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
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}', ) 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
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}', ) 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.
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', ) 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 |