ThreatMatch

  • ThreatMatch indicates a match when checking for threats in Safe Browsing threat lists, containing information about the threat type, platform, and entry type.

  • It includes optional metadata associated with the specific threat entry, which may provide additional context.

  • ThreatEntryMetadata stores this metadata as key-value pairs, understood by the client based on the threat type.

  • MetadataEntry represents a single metadata entry, where both the key and value are base64-encoded for JSON requests.

A match when checking a threat entry in the Safe Browsing threat lists.

JSON representation 
{
  "threatType": enum (ThreatType),
  "platformType": enum (PlatformType),
  "threatEntryType": enum (ThreatEntryType),
  "threat": {
    object (ThreatEntry)
  },
  "threatEntryMetadata": {
    object (ThreatEntryMetadata)
  },
  "cacheDuration": string
}
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)
    }
  ]
}
Fields
entries[]

object (MetadataEntry)

The metadata entries.

MetadataEntry

A single metadata entry.

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.