blob: af8cc523240dc97c2ff4962b4d6fbeccd1a1b4df [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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">Safe Browsing API</a> . <a href="safebrowsing_v4.threatHits.html">threatHits</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Reports a Safe Browsing threat list hit to Google. Only projects with</p>
80<h3>Method Details</h3>
81<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070082 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070083 <pre>Reports a Safe Browsing threat list hit to Google. Only projects with
84TRUSTED_REPORTER visibility can use this method.
85
86Args:
Dan O'Mearadd494642020-05-01 07:42:23 -070087 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088 The object takes the form of:
89
90{
Bu Sun Kim65020912020-05-20 12:08:20 -070091 &quot;resources&quot;: [ # The resources related to the threat hit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070092 { # A single resource related to a threat hit.
Bu Sun Kim65020912020-05-20 12:08:20 -070093 &quot;referrer&quot;: &quot;A String&quot;, # Referrer of the resource. Only set if the referrer is available.
94 &quot;type&quot;: &quot;A String&quot;, # The type of source reported.
95 &quot;url&quot;: &quot;A String&quot;, # The URL of the resource.
96 &quot;remoteIp&quot;: &quot;A String&quot;, # The remote IP of the resource in ASCII format. Either IPv4 or IPv6.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097 },
98 ],
Bu Sun Kim65020912020-05-20 12:08:20 -070099 &quot;entry&quot;: { # An individual threat; for example, a malicious URL or its hash # The threat entry responsible for the hit. Full hash should be reported for
100 # hash-based hits.
101 # representation. Only one of these fields should be set.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700102 &quot;digest&quot;: &quot;A String&quot;, # The digest of an executable in SHA256 format. The API supports both
103 # binary and hex digests. For JSON requests, digests are base64-encoded.
Bu Sun Kim65020912020-05-20 12:08:20 -0700104 &quot;hash&quot;: &quot;A String&quot;, # 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 &quot;url&quot;: &quot;A String&quot;, # A URL.
Bu Sun Kim65020912020-05-20 12:08:20 -0700108 },
109 &quot;platformType&quot;: &quot;A String&quot;, # The platform type reported.
110 &quot;userInfo&quot;: { # Details about the user that encountered the threat. # Details about the user that encountered the threat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700111 &quot;regionCode&quot;: &quot;A String&quot;, # The UN M.49 region code associated with the user&#x27;s location.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700112 &quot;userId&quot;: &quot;A String&quot;, # Unique user identifier defined by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700113 },
114 &quot;clientInfo&quot;: { # The client metadata associated with Safe Browsing API requests. # Client-reported identification.
115 &quot;clientId&quot;: &quot;A String&quot;, # A client ID that (hopefully) uniquely identifies the client implementation
116 # of the Safe Browsing API.
117 &quot;clientVersion&quot;: &quot;A String&quot;, # The version of the client implementation.
118 },
119 &quot;threatType&quot;: &quot;A String&quot;, # The threat type reported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120 }
121
122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
126
127Returns:
128 An object of the form:
129
130 { # A generic empty message that you can re-use to avoid defining duplicated
131 # empty messages in your APIs. A typical example is to use it as the request
132 # or the response type of an API method. For instance:
133 #
134 # service Foo {
135 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
136 # }
137 #
138 # The JSON representation for `Empty` is empty JSON object `{}`.
139 }</pre>
140</div>
141
142</body></html>