| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 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 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame^] | 75 | <h1><a href="safebrowsing_v4.html">Safe Browsing API</a> . <a href="safebrowsing_v4.encodedFullHashes.html">encodedFullHashes</a></h1> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#get">get(encodedRequest, clientVersion=None, clientId=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline"></p> |
| 80 | <h3>Method Details</h3> |
| 81 | <div class="method"> |
| 82 | <code class="details" id="get">get(encodedRequest, clientVersion=None, clientId=None, x__xgafv=None)</code> |
| 83 | <pre> |
| 84 | |
| 85 | Args: |
| 86 | encodedRequest: string, A serialized FindFullHashesRequest proto. (required) |
| 87 | clientVersion: string, The version of the client implementation. |
| 88 | clientId: string, A client ID that (hopefully) uniquely identifies the client implementation |
| 89 | of the Safe Browsing API. |
| 90 | x__xgafv: string, V1 error format. |
| 91 | Allowed values |
| 92 | 1 - v1 error format |
| 93 | 2 - v2 error format |
| 94 | |
| 95 | Returns: |
| 96 | An object of the form: |
| 97 | |
| 98 | { |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 99 | "negativeCacheDuration": "A String", # For requested entities that did not match the threat list, how long to |
| 100 | # cache the response. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 101 | "matches": [ # The full hashes that matched the requested prefixes. |
| 102 | { # A match when checking a threat entry in the Safe Browsing threat lists. |
| 103 | "threatType": "A String", # The threat type matching this threat. |
| 104 | "threatEntryMetadata": { # The metadata associated with a specific threat entry. The client is expected # Optional metadata associated with this threat. |
| 105 | # to know the metadata key/value pairs associated with each threat type. |
| 106 | "entries": [ # The metadata entries. |
| 107 | { # A single metadata entry. |
| Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame] | 108 | "key": "A String", # The metadata entry key. For JSON requests, the key is base64-encoded. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame^] | 109 | "value": "A String", # The metadata entry value. For JSON requests, the value is base64-encoded. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 110 | }, |
| 111 | ], |
| 112 | }, |
| 113 | "threatEntryType": "A String", # The threat entry type matching this threat. |
| 114 | "cacheDuration": "A String", # The cache lifetime for the returned match. Clients must not cache this |
| 115 | # response for more than this duration to avoid false positives. |
| 116 | "threat": { # An individual threat; for example, a malicious URL or its hash # The threat matching this threat. |
| 117 | # representation. Only one of these fields should be set. |
| 118 | "url": "A String", # A URL. |
| 119 | "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 |
| 120 | # hash. This field is in binary format. For JSON requests, hashes are |
| 121 | # base64-encoded. |
| 122 | "digest": "A String", # The digest of an executable in SHA256 format. The API supports both |
| 123 | # binary and hex digests. For JSON requests, digests are base64-encoded. |
| 124 | }, |
| 125 | "platformType": "A String", # The platform type matching this threat. |
| 126 | }, |
| 127 | ], |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 128 | "minimumWaitDuration": "A String", # The minimum duration the client must wait before issuing any find hashes |
| 129 | # request. If this field is not set, clients can issue a request as soon as |
| 130 | # they want. |
| 131 | }</pre> |
| 132 | </div> |
| 133 | |
| 134 | </body></html> |