Blame - docs/dyn/safebrowsing_v4.threatHits.html - platform/external/python/google-api-python-client

blob: af8cc523240dc97c2ff4962b4d6fbeccd1a1b4df [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[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
				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'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	79	<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'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	82	<code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	83	<pre>Reports a Safe Browsing threat list hit to Google. Only projects with
				84	TRUSTED_REPORTER visibility can use this method.
				85
				86	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	The object takes the form of:
				89
				90	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	91	"resources": [ # The resources related to the threat hit.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	92	{ # A single resource related to a threat hit.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	93	"referrer": "A String", # Referrer of the resource. Only set if the referrer is available.
				94	"type": "A String", # The type of source reported.
				95	"url": "A String", # The URL of the resource.
				96	"remoteIp": "A String", # The remote IP of the resource in ASCII format. Either IPv4 or IPv6.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	},
				98	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	99	"entry": { # 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 Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	102	"digest": "A String", # 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 Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	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	"url": "A String", # A URL.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	108	},
				109	"platformType": "A String", # The platform type reported.
				110	"userInfo": { # Details about the user that encountered the threat. # Details about the user that encountered the threat.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	111	"regionCode": "A String", # The UN M.49 region code associated with the user's location.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	112	"userId": "A String", # Unique user identifier defined by the client.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	113	},
				114	"clientInfo": { # The client metadata associated with Safe Browsing API requests. # Client-reported identification.
				115	"clientId": "A String", # A client ID that (hopefully) uniquely identifies the client implementation
				116	# of the Safe Browsing API.
				117	"clientVersion": "A String", # The version of the client implementation.
				118	},
				119	"threatType": "A String", # The threat type reported.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	120	}
				121
				122	x__xgafv: string, V1 error format.
				123	Allowed values
				124	1 - v1 error format
				125	2 - v2 error format
				126
				127	Returns:
				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>