Home | History | Annotate | Download | only in dyn
      1 <html><body>
      2 <style>
      3 
      4 body, h1, h2, h3, div, span, p, pre, a {
      5   margin: 0;
      6   padding: 0;
      7   border: 0;
      8   font-weight: inherit;
      9   font-style: inherit;
     10   font-size: 100%;
     11   font-family: inherit;
     12   vertical-align: baseline;
     13 }
     14 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, h2, h3 {
     50   border-bottom: solid #CCC 1px;
     51 }
     52 
     53 .toc_element {
     54   margin-top: 0.5em;
     55 }
     56 
     57 .firstline {
     58   margin-left: 2 em;
     59 }
     60 
     61 .method  {
     62   margin-top: 1em;
     63   border: solid 1px #CCC;
     64   padding: 1em;
     65   background: #EEE;
     66 }
     67 
     68 .details {
     69   font-weight: bold;
     70   font-size: 14px;
     71 }
     72 
     73 </style>
     74 
     75 <h1><a href="safebrowsing_v4.html">Google Safe Browsing API</a> . <a href="safebrowsing_v4.fullHashes.html">fullHashes</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#find">find(body, x__xgafv=None)</a></code></p>
     79 <p class="firstline">Finds the full hashes that match the requested hash prefixes.</p>
     80 <h3>Method Details</h3>
     81 <div class="method">
     82     <code class="details" id="find">find(body, x__xgafv=None)</code>
     83   <pre>Finds the full hashes that match the requested hash prefixes.
     84 
     85 Args:
     86   body: object, The request body. (required)
     87     The object takes the form of:
     88 
     89 { # Request to return full hashes matched by the provided hash prefixes.
     90     "client": { # The client metadata associated with Safe Browsing API requests. # The client metadata.
     91       "clientVersion": "A String", # The version of the client implementation.
     92       "clientId": "A String", # A client ID that (hopefully) uniquely identifies the client implementation
     93           # of the Safe Browsing API.
     94     },
     95     "apiClient": { # The client metadata associated with Safe Browsing API requests. # Client metadata associated with callers of higher-level APIs built on top
     96         # of the client's implementation.
     97       "clientVersion": "A String", # The version of the client implementation.
     98       "clientId": "A String", # A client ID that (hopefully) uniquely identifies the client implementation
     99           # of the Safe Browsing API.
    100     },
    101     "threatInfo": { # The information regarding one or more threats that a client submits when # The lists and hashes to be checked.
    102         # checking for matches in threat lists.
    103       "threatTypes": [ # The threat types to be checked.
    104         "A String",
    105       ],
    106       "threatEntries": [ # The threat entries to be checked.
    107         { # An individual threat; for example, a malicious URL or its hash
    108             # representation. Only one of these fields should be set.
    109           "url": "A String", # A URL.
    110           "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
    111               # hash. This field is in binary format. For JSON requests, hashes are
    112               # base64-encoded.
    113           "digest": "A String", # The digest of an executable in SHA256 format. The API supports both
    114               # binary and hex digests. For JSON requests, digests are base64-encoded.
    115         },
    116       ],
    117       "platformTypes": [ # The platform types to be checked.
    118         "A String",
    119       ],
    120       "threatEntryTypes": [ # The entry types to be checked.
    121         "A String",
    122       ],
    123     },
    124     "clientStates": [ # The current client states for each of the client's local threat lists.
    125       "A String",
    126     ],
    127   }
    128 
    129   x__xgafv: string, V1 error format.
    130     Allowed values
    131       1 - v1 error format
    132       2 - v2 error format
    133 
    134 Returns:
    135   An object of the form:
    136 
    137     {
    138     "negativeCacheDuration": "A String", # For requested entities that did not match the threat list, how long to
    139         # cache the response.
    140     "matches": [ # The full hashes that matched the requested prefixes.
    141       { # A match when checking a threat entry in the Safe Browsing threat lists.
    142         "threatType": "A String", # The threat type matching this threat.
    143         "threatEntryMetadata": { # The metadata associated with a specific threat entry. The client is expected # Optional metadata associated with this threat.
    144             # to know the metadata key/value pairs associated with each threat type.
    145           "entries": [ # The metadata entries.
    146             { # A single metadata entry.
    147               "value": "A String", # The metadata entry value. For JSON requests, the value is base64-encoded.
    148               "key": "A String", # The metadata entry key. For JSON requests, the key is base64-encoded.
    149             },
    150           ],
    151         },
    152         "threatEntryType": "A String", # The threat entry type matching this threat.
    153         "cacheDuration": "A String", # The cache lifetime for the returned match. Clients must not cache this
    154             # response for more than this duration to avoid false positives.
    155         "threat": { # An individual threat; for example, a malicious URL or its hash # The threat matching this threat.
    156             # representation. Only one of these fields should be set.
    157           "url": "A String", # A URL.
    158           "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
    159               # hash. This field is in binary format. For JSON requests, hashes are
    160               # base64-encoded.
    161           "digest": "A String", # The digest of an executable in SHA256 format. The API supports both
    162               # binary and hex digests. For JSON requests, digests are base64-encoded.
    163         },
    164         "platformType": "A String", # The platform type matching this threat.
    165       },
    166     ],
    167     "minimumWaitDuration": "A String", # The minimum duration the client must wait before issuing any find hashes
    168         # request. If this field is not set, clients can issue a request as soon as
    169         # they want.
    170   }</pre>
    171 </div>
    172 
    173 </body></html>