This page shows how to get started with the Cloud Client Libraries for the Cloud Data Loss Prevention API. Read more about the client libraries for Cloud APIs, including the older Google API Client Libraries, in Client Libraries Explained.
Cloud DLP client libraries mentioned on this page are supported on Compute Engine, App Engine - Flexible Environment, Google Kubernetes Engine, and Cloud Functions. Cloud DLP client library for Java is supported on Java 8 on App Engine standard environment.
If you are using Java 7 on App Engine standard environment, or App Engine - Standard environment with Go, PHP, or Python, use the REST Interface to access Cloud DLP.
Installing the client library
C#
For more information, see Setting Up a C# Development Environment.
To build and run a sample, open the solution file (Dlp.sln) with Visual Studio 2015 or later and build it.For more information, see the README.
Go
For more information, see Setting Up a Go Development Environment.
go get cloud.google.com/go/dlp
Java
For more information, see Setting Up a Java Development Environment.
If you are using Maven, add
the following to your pom.xml
file. For more information about
BOMs, see The Google Cloud Platform Libraries BOM.
If you are using Gradle, add the following to your dependencies:
If you are using sbt, add the following to your dependencies:
If you're using Visual Studio Code, IntelliJ, or Eclipse, you can add client libraries to your project using the following IDE plugins:
The plugins provide additional functionality, such as key management for service accounts. Refer to each plugin's documentation for details.
Node.js
For more information, see Setting Up a Node.js Development Environment.
npm install --save @google-cloud/dlp
PHP
For more information, see Using PHP on Google Cloud.
composer require google/cloud-dlp
Python
For more information, see Setting Up a Python Development Environment.
- Install pip and virtualenv if you do not already have them. You may want to refer to the Python Development Environment Setup Guide for Google Cloud for instructions.
- Clone or download the Google Cloud Python Docs Samples on GitHub.
- Create a virtualenv. Samples are compatible with Python 2.7.x and 3.4 and higher.
$ python -m venv dlp $ source dlp/bin/activate
- From the dlp directory within the cloned or unzipped
Google Cloud Python Docs Samples directory, install the dependencies needed to run the samples.
$ pip install -r requirements.txt
Ruby
For more information, see Setting Up a Ruby Development Environment.
gem install google-api-client
Setting up authentication
To run the client library, you must first set up authentication. One way to do that is to create a service account and set an environment variable, as shown in the following steps. For other ways to authenticate, see Authenticating as a service account.
Create a service account:
In the Cloud console, go to the Create service account page.
In the Service account name field, enter a name. The Cloud console fills
in the Service account ID field based on this name.
In the Service account description field, enter a description. For example,
To provide access to your project, grant the following role(s) to your
service account: Project > Owner.
In the Select a role list, select a role.
For additional roles, click
Click Done to finish creating the service account.
Do not close your browser window. You will use it in the next step.
Create a service account key:
Console
Service account for quickstart
.
Set up authentication:
Create the service account. Replace NAME with a name
for the service account:
Grant roles to the service account. Run the following command once for each of the
following IAM roles:
Replace the following:
Generate the key file:
Replace the following:
gcloud
gcloud iam service-accounts create NAME
roles/owner
:
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:NAME@PROJECT_ID.iam.gserviceaccount.com" --role=ROLE
gcloud iam service-accounts keys create FILE_NAME.json --iam-account=NAME@PROJECT_ID.iam.gserviceaccount.com
Provide authentication credentials to your application code by setting the
environment variable GOOGLE_APPLICATION_CREDENTIALS
. This
variable applies only to your current shell session. If you want the variable
to apply to future shell sessions, set the variable in your shell startup file,
for example in the ~/.bashrc
or ~/.profile
file.
Linux or macOS
export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH
"
Replace KEY_PATH
with the path of the JSON file that contains your service account key.
For example:
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"
Windows
For PowerShell:
$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH
"
Replace KEY_PATH
with the path of the JSON file that contains your service account key.
For example:
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"
For command prompt:
set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH
Replace KEY_PATH
with the path of the JSON file that contains your service account key.
Using the client library
The following example shows how to use the client library.
Go
To learn how to install and use the client library for Cloud DLP, see Cloud DLP client libraries. For more information, see the Cloud DLP Go API reference documentation.
Java
To learn how to install and use the client library for Cloud DLP, see Cloud DLP client libraries. For more information, see the Cloud DLP Java API reference documentation.
Node.js
To learn how to install and use the client library for Cloud DLP, see Cloud DLP client libraries. For more information, see the Cloud DLP Node.js API reference documentation.
PHP
To learn how to install and use the client library for Cloud DLP, see Cloud DLP client libraries. For more information, see the Cloud DLP PHP API reference documentation.
Python
To learn how to install and use the client library for Cloud DLP, see Cloud DLP client libraries. For more information, see the Cloud DLP Python API reference documentation.