ThreatMatch
Stay organized with collections
Save and categorize content based on your preferences.
A match when checking a threat entry in the Safe Browsing threat lists.
Fields |
threatType |
enum (ThreatType )
The threat type matching this threat.
|
platformType |
enum (PlatformType )
The platform type matching this threat.
|
threatEntryType |
enum (ThreatEntryType )
The threat entry type matching this threat.
|
threat |
object (ThreatEntry )
The threat matching this threat.
|
threatEntryMetadata |
object (ThreatEntryMetadata )
Optional metadata associated with this threat.
|
cacheDuration |
string (Duration format)
The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives. A duration in seconds with up to nine fractional digits, ending with 's '. Example: "3.5s" .
|
ThreatEntryMetadata
The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type.
JSON representation |
{
"entries": [
{
object (MetadataEntry )
}
]
} |
MetadataEntry
JSON representation |
{
"key": string,
"value": string
} |
Fields |
key |
string (bytes format)
The metadata entry key. For JSON requests, the key is base64-encoded. A base64-encoded string.
|
value |
string (bytes format)
The metadata entry value. For JSON requests, the value is base64-encoded. A base64-encoded string.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-05 UTC.
[null,null,["Last updated 2025-03-05 UTC."],[[["\u003cp\u003eThreatMatch indicates a match when checking for threats in Safe Browsing threat lists, containing information about the threat type, platform, and entry type.\u003c/p\u003e\n"],["\u003cp\u003eIt includes optional metadata associated with the specific threat entry, which may provide additional context.\u003c/p\u003e\n"],["\u003cp\u003eThreatEntryMetadata stores this metadata as key-value pairs, understood by the client based on the threat type.\u003c/p\u003e\n"],["\u003cp\u003eMetadataEntry represents a single metadata entry, where both the key and value are base64-encoded for JSON requests.\u003c/p\u003e\n"]]],["The document defines data structures for threat matches in Safe Browsing. A threat match includes `threatType`, `platformType`, `threatEntryType`, and the matching `threat`. It may optionally contain `threatEntryMetadata`, consisting of `MetadataEntry` objects with `key` and `value` string pairs. Each match also specifies `cacheDuration`, dictating how long the match should be considered valid, to avoid false positives. Data representation is in JSON format with specific structure for `ThreatEntryMetadata` and `MetadataEntry`.\n"],null,["# ThreatMatch\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [ThreatEntryMetadata](#ThreatEntryMetadata)\n - [JSON representation](#ThreatEntryMetadata.SCHEMA_REPRESENTATION)\n- [MetadataEntry](#MetadataEntry)\n - [JSON representation](#MetadataEntry.SCHEMA_REPRESENTATION)\n\nA match when checking a threat entry in the Safe Browsing threat lists.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"threatType\": enum (/safe-browsing/reference/rest/v4/ThreatType), \"platformType\": enum (/safe-browsing/reference/rest/v4/PlatformType), \"threatEntryType\": enum (/safe-browsing/reference/rest/v4/ThreatEntryType), \"threat\": { object (/safe-browsing/reference/rest/v4/ThreatEntry) }, \"threatEntryMetadata\": { object (/safe-browsing/reference/rest/v4/ThreatMatch#ThreatEntryMetadata) }, \"cacheDuration\": string } ``` |\n\n| Fields ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `threatType` | `enum (`[ThreatType](/safe-browsing/reference/rest/v4/ThreatType)`)` The threat type matching this threat. |\n| `platformType` | `enum (`[PlatformType](/safe-browsing/reference/rest/v4/PlatformType)`)` The platform type matching this threat. |\n| `threatEntryType` | `enum (`[ThreatEntryType](/safe-browsing/reference/rest/v4/ThreatEntryType)`)` The threat entry type matching this threat. |\n| `threat` | `object (`[ThreatEntry](/safe-browsing/reference/rest/v4/ThreatEntry)`)` The threat matching this threat. |\n| `threatEntryMetadata` | `object (`[ThreatEntryMetadata](/safe-browsing/reference/rest/v4/ThreatMatch#ThreatEntryMetadata)`)` Optional metadata associated with this threat. |\n| `cacheDuration` | `string (`[Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration)` format)` The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n\nThreatEntryMetadata\n-------------------\n\nThe metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------|\n| ``` { \"entries\": [ { object (/safe-browsing/reference/rest/v4/ThreatMatch#MetadataEntry) } ] } ``` |\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------------|\n| `entries[]` | `object (`[MetadataEntry](/safe-browsing/reference/rest/v4/ThreatMatch#MetadataEntry)`)` The metadata entries. |\n\nMetadataEntry\n-------------\n\nA single metadata entry.\n\n| JSON representation |\n|--------------------------------------------|\n| ``` { \"key\": string, \"value\": string } ``` |\n\n| Fields ||\n|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `key` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` The metadata entry key. For JSON requests, the key is base64-encoded. A base64-encoded string. |\n| `value` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` The metadata entry value. For JSON requests, the value is base64-encoded. A base64-encoded string. |"]]