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.threatMatches.html">threatMatches</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 threat entries that match the Safe Browsing lists.</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 threat entries that match the Safe Browsing lists.
     84 
     85 Args:
     86   body: object, The request body. (required)
     87     The object takes the form of:
     88 
     89 { # Request to check entries against lists.
     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     "threatInfo": { # The information regarding one or more threats that a client submits when # The lists and entries to be checked for matches.
     96         # checking for matches in threat lists.
     97       "threatTypes": [ # The threat types to be checked.
     98         "A String",
     99       ],
    100       "threatEntries": [ # The threat entries to be checked.
    101         { # An individual threat; for example, a malicious URL or its hash
    102             # representation. Only one of these fields should be set.
    103           "url": "A String", # A URL.
    104           "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
    105               # hash. This field is in binary format. For JSON requests, hashes are
    106               # base64-encoded.
    107           "digest": "A String", # The digest of an executable in SHA256 format. The API supports both
    108               # binary and hex digests. For JSON requests, digests are base64-encoded.
    109         },
    110       ],
    111       "platformTypes": [ # The platform types to be checked.
    112         "A String",
    113       ],
    114       "threatEntryTypes": [ # The entry types to be checked.
    115         "A String",
    116       ],
    117     },
    118   }
    119 
    120   x__xgafv: string, V1 error format.
    121     Allowed values
    122       1 - v1 error format
    123       2 - v2 error format
    124 
    125 Returns:
    126   An object of the form:
    127 
    128     {
    129     "matches": [ # The threat list matches.
    130       { # A match when checking a threat entry in the Safe Browsing threat lists.
    131         "threatType": "A String", # The threat type matching this threat.
    132         "threatEntryMetadata": { # The metadata associated with a specific threat entry. The client is expected # Optional metadata associated with this threat.
    133             # to know the metadata key/value pairs associated with each threat type.
    134           "entries": [ # The metadata entries.
    135             { # A single metadata entry.
    136               "value": "A String", # The metadata entry value. For JSON requests, the value is base64-encoded.
    137               "key": "A String", # The metadata entry key. For JSON requests, the key is base64-encoded.
    138             },
    139           ],
    140         },
    141         "threatEntryType": "A String", # The threat entry type matching this threat.
    142         "cacheDuration": "A String", # The cache lifetime for the returned match. Clients must not cache this
    143             # response for more than this duration to avoid false positives.
    144         "threat": { # An individual threat; for example, a malicious URL or its hash # The threat matching this threat.
    145             # representation. Only one of these fields should be set.
    146           "url": "A String", # A URL.
    147           "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
    148               # hash. This field is in binary format. For JSON requests, hashes are
    149               # base64-encoded.
    150           "digest": "A String", # The digest of an executable in SHA256 format. The API supports both
    151               # binary and hex digests. For JSON requests, digests are base64-encoded.
    152         },
    153         "platformType": "A String", # The platform type matching this threat.
    154       },
    155     ],
    156   }</pre>
    157 </div>
    158 
    159 </body></html>