Why Google Solutions Products Pricing Getting started Docs Support
Docs Support


Google Cloud Platform logo

Google Cloud Data Loss Prevention (DLP) API: Node.js Client

release level CircleCI AppVeyor codecov

Node.js idiomatic client for Data Loss Prevention (DLP) API .

Client API Reference


Before you begin

  1. Select or create a Cloud Platform project.

    Go to the projects page

  2. Enable billing for your project.

    Enable billing

  3. Enable the Google Cloud Data Loss Prevention (DLP) API API.

    Enable the API

  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install --save @google-cloud/dlp

Using the client library

// Imports the Google Cloud Data Loss Prevention library
const DLP = require('@google-cloud/dlp');

// Instantiates a client
const dlp = new DLP.DlpServiceClient();

// The string to inspect
const string = 'Robert Frost';

// The minimum likelihood required before returning a match
const minLikelihood = 'LIKELIHOOD_UNSPECIFIED';

// The maximum number of findings to report (0 = server maximum)
const maxFindings = 0;

// The infoTypes of information to match
const infoTypes = [
  { name: 'US_MALE_NAME' },
  { name: 'US_FEMALE_NAME' }

// Whether to include the matching string
const includeQuote = true;

// Construct items to inspect
const items = [{ type: 'text/plain', value: string }];

// Construct request
const request = {
  inspectConfig: {
    infoTypes: infoTypes,
    minLikelihood: minLikelihood,
    maxFindings: maxFindings,
    includeQuote: includeQuote
  items: items

// Run request
  .then((response) => {
    const findings = response[0].results[0].findings;
    if (findings.length > 0) {
      findings.forEach((finding) => {
        if (includeQuote) {
          console.log(`\tQuote: ${finding.quote}`);
        console.log(`\tInfo type: ${finding.infoType.name}`);
        console.log(`\tLikelihood: ${finding.likelihood}`);
    } else {
      console.log(`No findings.`);
  .catch((err) => {
    console.error(`Error in inspectString: ${err.message || err}`);


Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample Source Code
Inspect source code
Redact source code
Metadata source code
DeID source code
Risk Analysis source code

The Data Loss Prevention (DLP) API Node.js Client API Reference documentation also contains samples.


This library follows Semantic Versioning .

This library is considered to be in beta . This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide .


Apache Version 2.0