docs/dyn/webrisk_v1.hashes.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="webrisk_v1.html">Web Risk API</a> . <a href="webrisk_v1.hashes.html">hashes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#search">search(hashPrefix=None, threatTypes=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="search">search(hashPrefix=None, threatTypes=None, x__xgafv=None)</code>
  <pre>Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.

Args:
  hashPrefix: string, A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. For JSON requests, this field is base64-encoded. Note that if this parameter is provided by a URI, it must be encoded using the web safe base64 variant (RFC 4648).
  threatTypes: string, Required. The ThreatLists to search in. Multiple ThreatLists may be specified. (repeated)
    Allowed values
      THREAT_TYPE_UNSPECIFIED - No entries should match this threat type. This threat type is unused.
      MALWARE - Malware targeting any platform.
      SOCIAL_ENGINEERING - Social engineering targeting any platform.
      UNWANTED_SOFTWARE - Unwanted software targeting any platform.
      SOCIAL_ENGINEERING_EXTENDED_COVERAGE - A list of extended coverage social engineering URIs targeting any platform.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;negativeExpireTime&quot;: &quot;A String&quot;, # For requested entities that did not match the threat list, how long to cache the response until.
  &quot;threats&quot;: [ # The full hashes that matched the requested prefixes. The hash will be populated in the key.
    { # Contains threat information on a matching hash.
      &quot;expireTime&quot;: &quot;A String&quot;, # The cache lifetime for the returned match. Clients must not cache this response past this timestamp to avoid false positives.
      &quot;hash&quot;: &quot;A String&quot;, # A 32 byte SHA256 hash. This field is in binary format. For JSON requests, hashes are base64-encoded.
      &quot;threatTypes&quot;: [ # The ThreatList this threat belongs to. This must contain at least one entry.
        &quot;A String&quot;,
      ],
    },
  ],
}</pre>
</div>

</body></html>