View Source API Reference google_api_safe_browsing v0.25.0
Modules
API client metadata for GoogleApi.SafeBrowsing.V4.
API calls for all endpoints tagged EncodedFullHashes.
API calls for all endpoints tagged EncodedUpdates.
API calls for all endpoints tagged FullHashes.
API calls for all endpoints tagged ThreatHits.
API calls for all endpoints tagged ThreatListUpdates.
API calls for all endpoints tagged ThreatLists.
API calls for all endpoints tagged ThreatMatches.
Handle Tesla connections for GoogleApi.SafeBrowsing.V4.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
The expected state of a client's local database.
The client metadata associated with Safe Browsing API requests.
Describes a Safe Browsing API update request. Clients can request updates for multiple lists in a single request. The server may not respond to all requests, if the server has no updates for that list. NOTE: Field index 2 is unused. NEXT: 5
A single list update request.
The constraints for this update.
Attributes
-
listUpdateResponses(type:list(GoogleApi.SafeBrowsing.V4.Model.GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponseListUpdateResponse.t), default:nil) - The list updates requested by the clients. The number of responses here may be less than the number of requests sent by clients. This is the case, for example, if the server has no updates for a particular list. -
minimumWaitDuration(type:String.t, default:nil) - The minimum duration the client must wait before issuing any update request. If this field is not set clients may update as soon as they want.
An update to an individual list.
Request to return full hashes matched by the provided hash prefixes.
Attributes
-
matches(type:list(GoogleApi.SafeBrowsing.V4.Model.GoogleSecuritySafebrowsingV4ThreatMatch.t), default:nil) - The full hashes that matched the requested prefixes. -
minimumWaitDuration(type:String.t, default:nil) - The minimum duration the client must wait before issuing any find hashes request. If this field is not set, clients can issue a request as soon as they want. -
negativeCacheDuration(type:String.t, default:nil) - For requested entities that did not match the threat list, how long to cache the response.
Request to check entries against lists.
The uncompressed threat entries in hash format of a particular prefix length. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some hashes are lengthened if they collide with the hash of a popular URL. Used for sending ThreatEntrySet to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression.
A set of raw indices to remove from a local list.
The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices.
An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set.
The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type.
A single metadata entry.
A set of threats that should be added or removed from a client's local database.
Attributes
-
clientInfo(type:GoogleApi.SafeBrowsing.V4.Model.GoogleSecuritySafebrowsingV4ClientInfo.t, default:nil) - Client-reported identification. -
entry(type:GoogleApi.SafeBrowsing.V4.Model.GoogleSecuritySafebrowsingV4ThreatEntry.t, default:nil) - The threat entry responsible for the hit. Full hash should be reported for hash-based hits. -
platformType(type:String.t, default:nil) - The platform type reported. -
resources(type:list(GoogleApi.SafeBrowsing.V4.Model.GoogleSecuritySafebrowsingV4ThreatHitThreatSource.t), default:nil) - The resources related to the threat hit. -
threatType(type:String.t, default:nil) - The threat type reported. -
userInfo(type:GoogleApi.SafeBrowsing.V4.Model.GoogleSecuritySafebrowsingV4ThreatHitUserInfo.t, default:nil) - Details about the user that encountered the threat.
A single resource related to a threat hit.
Details about the user that encountered the threat.
The information regarding one or more threats that a client submits when checking for matches in threat lists.
Describes an individual threat list. A list is defined by three parameters: the type of threat posed, the type of platform targeted by the threat, and the type of entries in the list.
A match when checking a threat entry in the Safe Browsing threat lists.
API client metadata for GoogleApi.SafeBrowsing.V5.
API calls for all endpoints tagged Hashes.
Handle Tesla connections for GoogleApi.SafeBrowsing.V5.
The full hash identified with one or more matches.
Details about a matching full hash. An important note about forward compatibility: new threat types and threat attributes may be added by the server at any time; those additions are considered minor version changes. It is Google's policy not to expose minor version numbers in APIs (see https://cloud.google.com/apis/design/versioning for the versioning policy), so clients MUST be prepared to receive FullHashDetail messages containing ThreatType enum values or ThreatAttribute enum values that are considered invalid by the client. Therefore, it is the client's responsibility to check for the validity of all ThreatType and ThreatAttribute enum values; if any value is considered invalid, the client MUST disregard the entire FullHashDetail message.
The response returned after searching threat hashes. If nothing is found, the server will return an OK status (HTTP status code 200) with the full_hashes field empty, rather than returning a NOT_FOUND status (HTTP status code 404). What's new in V5: There is a separation between FullHash and FullHashDetail. In the case when a hash represents a site having multiple threats (e.g. both MALWARE and SOCIAL_ENGINEERING), the full hash does not need to be sent twice as in V4. Furthermore, the cache duration has been simplified into a single cache_duration field.