/**
* Check a URI against the WebRisk API.
* @param {string} uri A URI to pass to the Web Risk API.
*/
async function quickstart(uri) {
// Create the WebRisk client library.
const {WebRiskServiceClient, protos} = require('@google-cloud/web-risk');
const client = new WebRiskServiceClient();
// Create an API request to check for malware, social engineering,
// and unwanted software.
const request = {
uri: uri,
threatTypes: [
protos.google.cloud.webrisk.v1.ThreatType.MALWARE,
protos.google.cloud.webrisk.v1.ThreatType.SOCIAL_ENGINEERING,
protos.google.cloud.webrisk.v1.ThreatType.UNWANTED_SOFTWARE,
],
};
// call the WebRisk searchUris API.
const {threat} = (await client.searchUris(request))[0];
if (threat) {
console.info(threat);
} else {
console.info('no threats found');
}
}
Samples
Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
Our client libraries follow the Node.js release schedule.
Libraries are compatible with all current active and maintenance versions of
Node.js.
If you are using an end-of-life version of Node.js, we recommend that you update
as soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on a
best-efforts basis with the following warnings:
Legacy versions are not tested in continuous integration.
Some security patches and features cannot be backported.
Dependencies cannot be kept up-to-date.
Client libraries targeting some end-of-life versions of Node.js are available, and
can be installed through npm dist-tags.
The dist-tags follow the naming convention legacy-(version).
For example, npm install @google-cloud/web-risk@legacy-8 installs client libraries
for versions compatible with Node.js 8.
This library is considered to be stable. The code surface will not change in backwards-incompatible ways
unless absolutely necessary (e.g. because of critical security issues) or with
an extensive deprecation period. Issues and requests against stable libraries
are addressed with the highest priority.
Please note that this README.md, the samples/README.md,
and a variety of configuration files in this repository (including .nycrc and tsconfig.json)
are generated from a central template. To edit one of these files, make an edit
to its templates in
directory.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["Version latestkeyboard_arrow_down\n\n- [5.2.0 (latest)](/nodejs/docs/reference/web-risk/latest)\n- [4.0.2](/nodejs/docs/reference/web-risk/4.0.2)\n- [3.2.2](/nodejs/docs/reference/web-risk/3.2.2)\n- [3.1.1](/nodejs/docs/reference/web-risk/3.1.1)\n- [2.2.0](/nodejs/docs/reference/web-risk/2.2.0)\n- [2.1.8](/nodejs/docs/reference/web-risk/2.1.8) \n\n[Web Risk API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-webrisk)\n=======================================================================================================================\n\n[](https://cloud.google.com/terms/launch-stages)\n[](https://www.npmjs.org/package/@google-cloud/web-risk)\n\nWeb Risk API client for Node.js\n\nA comprehensive list of changes in each version may be found in\n[the CHANGELOG](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-webrisk/CHANGELOG.md).\n\n- [Web Risk API Node.js Client API Reference](https://googleapis.dev/nodejs/web-risk/latest)\n- [Web Risk API Documentation](https://cloud.google.com/web-risk/docs/)\n- [github.com/googleapis/google-cloud-node/packages/google-cloud-webrisk](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-webrisk)\n\nRead more about the client libraries for Cloud APIs, including the older\nGoogle APIs Client Libraries, in [Client Libraries Explained](https://cloud.google.com/apis/docs/client-libraries-explained).\n\n**Table of contents:**\n\n- [Quickstart](#quickstart)\n - [Before you begin](#before-you-begin)\n - [Installing the client library](#installing-the-client-library)\n - [Using the client library](#using-the-client-library)\n- [Samples](#samples)\n- [Versioning](#versioning)\n- [Contributing](#contributing)\n- [License](#license)\n\nQuickstart\n----------\n\n### Before you begin\n\n1. [Select or create a Cloud Platform project](https://console.cloud.google.com/project).\n2. [Enable billing for your project](https://support.google.com/cloud/answer/6293499#enable-billing).\n3. [Enable the Web Risk API API](https://console.cloud.google.com/flows/enableapi?apiid=webrisk.googleapis.com).\n4. [Set up authentication](https://cloud.google.com/docs/authentication/external/set-up-adc-local) so you can access the API from your local workstation.\n\n### Installing the client library\n\n npm install @google-cloud/web-risk\n\n### Using the client library\n\n /**\n * Check a URI against the WebRisk API.\n * @param {string} uri A URI to pass to the Web Risk API.\n */\n async function quickstart(uri) {\n // Create the WebRisk client library.\n const {WebRiskServiceClient, protos} = require('https://cloud.google.com/nodejs/docs/reference/web-risk/latest/overview.html');\n const client = new https://cloud.google.com/nodejs/docs/reference/web-risk/latest/overview.html();\n\n // Create an API request to check for malware, social engineering,\n // and unwanted software.\n const request = {\n uri: uri,\n threatTypes: [\n protos.google.cloud.webrisk.v1.https://cloud.google.com/nodejs/docs/reference/web-risk/latest/web-risk/protos.google.cloud.webrisk.v1.threattype.html.https://cloud.google.com/nodejs/docs/reference/web-risk/latest/web-risk/protos.google.cloud.webrisk.v1.threattype.html,\n protos.google.cloud.webrisk.v1.https://cloud.google.com/nodejs/docs/reference/web-risk/latest/web-risk/protos.google.cloud.webrisk.v1.threattype.html.https://cloud.google.com/nodejs/docs/reference/web-risk/latest/web-risk/protos.google.cloud.webrisk.v1.threattype.html,\n protos.google.cloud.webrisk.v1.https://cloud.google.com/nodejs/docs/reference/web-risk/latest/web-risk/protos.google.cloud.webrisk.v1.threattype.html.https://cloud.google.com/nodejs/docs/reference/web-risk/latest/web-risk/protos.google.cloud.webrisk.v1.threattype.html,\n ],\n };\n\n // call the WebRisk searchUris API.\n const {threat} = (await client.searchUris(request))[0];\n if (threat) {\n console.info(threat);\n } else {\n console.info('no threats found');\n }\n }\n\nSamples\n-------\n\nSamples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-webrisk/samples) directory. Each sample's `README.md` has instructions for running its sample.\n\nThe [Web Risk API Node.js Client API Reference](https://googleapis.dev/nodejs/web-risk/latest) documentation\nalso contains samples.\n\nSupported Node.js Versions\n--------------------------\n\nOur client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).\nLibraries are compatible with all current *active* and *maintenance* versions of\nNode.js.\nIf you are using an end-of-life version of Node.js, we recommend that you update\nas soon as possible to an actively supported LTS version.\n\nGoogle's client libraries support legacy versions of Node.js runtimes on a\nbest-efforts basis with the following warnings:\n\n- Legacy versions are not tested in continuous integration.\n- Some security patches and features cannot be backported.\n- Dependencies cannot be kept up-to-date.\n\nClient libraries targeting some end-of-life versions of Node.js are available, and\ncan be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).\nThe dist-tags follow the naming convention `legacy-(version)`.\nFor example, `npm install @google-cloud/web-risk@legacy-8` installs client libraries\nfor versions compatible with Node.js 8.\n\nVersioning\n----------\n\nThis library follows [Semantic Versioning](http://semver.org/).\n\nThis library is considered to be **stable** . The code surface will not change in backwards-incompatible ways\nunless absolutely necessary (e.g. because of critical security issues) or with\nan extensive deprecation period. Issues and requests against **stable** libraries\nare addressed with the highest priority.\n\nMore Information: [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages)\n\nContributing\n------------\n\nContributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).\n\nPlease note that this `README.md`, the `samples/README.md`,\nand a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)\nare generated from a central template. To edit one of these files, make an edit\nto its templates in\n[directory](https://github.com/googleapis/synthtool).\n\nLicense\n-------\n\nApache Version 2.0\n\nSee [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)"]]