WebRiskServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.webrisk_v1.services.web_risk_service.transports.base.WebRiskServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Web Risk API defines an interface to detect malicious URLs on your website and in client applications.
Properties
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
WebRiskServiceTransport | The transport used by the client instance. |
Methods
WebRiskServiceClient
WebRiskServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.webrisk_v1.services.web_risk_service.transports.base.WebRiskServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the web risk service client.
| Parameters | |
|---|---|
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, WebRiskServiceTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
compute_threat_list_diff
compute_threat_list_diff(request: Optional[Union[google.cloud.webrisk_v1.types.webrisk.ComputeThreatListDiffRequest, dict]] = None, *, threat_type: Optional[google.cloud.webrisk_v1.types.webrisk.ThreatType] = None, version_token: Optional[bytes] = None, constraints: Optional[google.cloud.webrisk_v1.types.webrisk.ComputeThreatListDiffRequest.Constraints] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the most recent threat list diffs. These diffs should be applied to a local database of hashes to keep it up-to-date. If the local database is empty or excessively out-of-date, a complete snapshot of the database will be returned. This Method only updates a single ThreatList at a time. To update multiple ThreatList databases, this method needs to be called once for each list.
from google.cloud import webrisk_v1
def sample_compute_threat_list_diff():
# Create a client
client = webrisk_v1.WebRiskServiceClient()
# Initialize request argument(s)
request = webrisk_v1.ComputeThreatListDiffRequest(
threat_type="UNWANTED_SOFTWARE",
)
# Make the request
response = client.compute_threat_list_diff(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.webrisk_v1.types.ComputeThreatListDiffRequest, dict]
The request object. Describes an API diff request. |
threat_type |
google.cloud.webrisk_v1.types.ThreatType
Required. The threat list to update. Only a single ThreatType should be specified. This corresponds to the |
version_token |
bytes
The current version token of the client for the requested list (the client version that was received from the last successful diff). If the client does not have a version token (this is the first time calling ComputeThreatListDiff), this may be left empty and a full database snapshot will be returned. This corresponds to the |
constraints |
google.cloud.webrisk_v1.types.ComputeThreatListDiffRequest.Constraints
Required. The constraints associated with this request. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
create_submission
create_submission(request: Optional[Union[google.cloud.webrisk_v1.types.webrisk.CreateSubmissionRequest, dict]] = None, *, parent: Optional[str] = None, submission: Optional[google.cloud.webrisk_v1.types.webrisk.Submission] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a Submission of a URI suspected of containing phishing
content to be reviewed. If the result verifies the existence of
malicious phishing content, the site will be added to the
Google's Social Engineering
lists <https://support.google.com/webmasters/answer/6350487/>__
in order to protect users that could get exposed to this threat
in the future. Only projects with CREATE_SUBMISSION_USERS
visibility can use this method.
from google.cloud import webrisk_v1
def sample_create_submission():
# Create a client
client = webrisk_v1.WebRiskServiceClient()
# Initialize request argument(s)
submission = webrisk_v1.Submission()
submission.uri = "uri_value"
request = webrisk_v1.CreateSubmissionRequest(
parent="parent_value",
submission=submission,
)
# Make the request
response = client.create_submission(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.webrisk_v1.types.CreateSubmissionRequest, dict]
The request object. Request to send a potentially phishy URI to WebRisk. |
parent |
str
Required. The name of the project that is making the submission. This string is in the format "projects/{project_number}". This corresponds to the |
submission |
google.cloud.webrisk_v1.types.Submission
Required. The submission that contains the content of the phishing report. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.webrisk_v1.types.Submission | Wraps a URI that might be displaying phishing content. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
WebRiskServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
WebRiskServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
WebRiskServiceClient | The constructed client. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Parameter | |
|---|---|
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Returns | |
|---|---|
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
search_hashes
search_hashes(request: Optional[Union[google.cloud.webrisk_v1.types.webrisk.SearchHashesRequest, dict]] = None, *, hash_prefix: Optional[bytes] = None, threat_types: Optional[Sequence[google.cloud.webrisk_v1.types.webrisk.ThreatType]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.
from google.cloud import webrisk_v1
def sample_search_hashes():
# Create a client
client = webrisk_v1.WebRiskServiceClient()
# Initialize request argument(s)
request = webrisk_v1.SearchHashesRequest(
threat_types="UNWANTED_SOFTWARE",
)
# Make the request
response = client.search_hashes(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.webrisk_v1.types.SearchHashesRequest, dict]
The request object. Request to return full hashes matched by the provided hash prefixes. |
hash_prefix |
bytes
A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. For JSON requests, this field is base64-encoded. This corresponds to the |
threat_types |
Sequence[google.cloud.webrisk_v1.types.ThreatType]
Required. The ThreatLists to search in. Multiple ThreatLists may be specified. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
search_uris
search_uris(request: Optional[Union[google.cloud.webrisk_v1.types.webrisk.SearchUrisRequest, dict]] = None, *, uri: Optional[str] = None, threat_types: Optional[Sequence[google.cloud.webrisk_v1.types.webrisk.ThreatType]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())This method is used to check whether a URI is on a given threatList. Multiple threatLists may be searched in a single query. The response will list all requested threatLists the URI was found to match. If the URI is not found on any of the requested ThreatList an empty response will be returned.
from google.cloud import webrisk_v1
def sample_search_uris():
# Create a client
client = webrisk_v1.WebRiskServiceClient()
# Initialize request argument(s)
request = webrisk_v1.SearchUrisRequest(
uri="uri_value",
threat_types="UNWANTED_SOFTWARE",
)
# Make the request
response = client.search_uris(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.webrisk_v1.types.SearchUrisRequest, dict]
The request object. Request to check URI entries against threatLists. |
uri |
str
Required. The URI to be checked for matches. This corresponds to the |
threat_types |
Sequence[google.cloud.webrisk_v1.types.ThreatType]
Required. The ThreatLists to search in. Multiple ThreatLists may be specified. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |