Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / safebrowsing_v4.threatHits.html
blob: 09157c155a8848564202304c2c6803108671d524 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Reports a Safe Browsing threat list hit to Google. Only projects with TRUSTED_REPORTER visibility can use this method.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <pre>Reports a Safe Browsing threat list hit to Google. Only projects with TRUSTED_REPORTER visibility can use this method.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92
93Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]94 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95 The object takes the form of:
96
97{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]98 &quot;clientInfo&quot;: { # The client metadata associated with Safe Browsing API requests. # Client-reported identification.
99 &quot;clientId&quot;: &quot;A String&quot;, # A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
100 &quot;clientVersion&quot;: &quot;A String&quot;, # The version of the client implementation.
101 },
102 &quot;entry&quot;: { # An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set. # The threat entry responsible for the hit. Full hash should be reported for hash-based hits.
103 &quot;digest&quot;: &quot;A String&quot;, # The digest of an executable in SHA256 format. The API supports both binary and hex digests. For JSON requests, digests are base64-encoded.
104 &quot;hash&quot;: &quot;A String&quot;, # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format. For JSON requests, hashes are base64-encoded.
105 &quot;url&quot;: &quot;A String&quot;, # A URL.
106 },
107 &quot;platformType&quot;: &quot;A String&quot;, # The platform type reported.
108 &quot;resources&quot;: [ # The resources related to the threat hit.
109 { # A single resource related to a threat hit.
110 &quot;referrer&quot;: &quot;A String&quot;, # Referrer of the resource. Only set if the referrer is available.
111 &quot;remoteIp&quot;: &quot;A String&quot;, # The remote IP of the resource in ASCII format. Either IPv4 or IPv6.
112 &quot;type&quot;: &quot;A String&quot;, # The type of source reported.
113 &quot;url&quot;: &quot;A String&quot;, # The URL of the resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]114 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]115 ],
116 &quot;threatType&quot;: &quot;A String&quot;, # The threat type reported.
117 &quot;userInfo&quot;: { # Details about the user that encountered the threat. # Details about the user that encountered the threat.
118 &quot;regionCode&quot;: &quot;A String&quot;, # The UN M.49 region code associated with the user&#x27;s location.
119 &quot;userId&quot;: &quot;A String&quot;, # Unique user identifier defined by the client.
120 },
121}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122
123 x__xgafv: string, V1 error format.
124 Allowed values
125 1 - v1 error format
126 2 - v2 error format
127
128Returns:
129 An object of the form:
130
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]131 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]132}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133</div>
134
135</body></html>