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 APIs 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 -u github.com/GoogleCloudPlatform/golang-samples/tree/master/dlp
Java
For more information, see Setting Up a Java Development Environment.
If you are using Maven, add this to your pom.xml file:<dependency> <groupId>com.google.cloud</groupId> <artifactId>google-cloud-dlp</artifactId> <version></version> </dependency>
If you are using Gradle, add this to your dependencies:
compile group: 'com.google.cloud', name: 'google-cloud-dlp', version: ''
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 venv $ source env/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 by creating a service account and setting an environment variable. Complete the following steps to set up authentication. For other ways to authenticate, see the GCP authentication documentation.
Cloud Console
-
In the Cloud Console, go to the Create service account key page.
Go to the Create Service Account Key page - From the Service account list, select New service account.
- In the Service account name field, enter a name.
From the Role list, select Project > Owner.
- Click Create. A JSON file that contains your key downloads to your computer.
Command line
You can run the following commands using the Cloud SDK on your local machine, or in Cloud Shell.
-
Create the service account. Replace NAME with a name for the service account.
gcloud iam service-accounts create NAME
-
Grant permissions to the service account. Replace PROJECT_ID with your project ID.
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:NAME@PROJECT_ID.iam.gserviceaccount.com" --role="roles/owner"
-
Generate the key file. Replace FILE_NAME with a name for the key file.
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
.
Replace [PATH] with the file path of the JSON file that contains your
service account key. This variable only applies to your current shell session,
so if you open a new session, set the variable again.
Linux or macOS
export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"
For example:
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/my-key.json"
Windows
With PowerShell:
$env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"
For example:
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\my-key.json"
With command prompt:
set GOOGLE_APPLICATION_CREDENTIALS=[PATH]
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 the Cloud DLP Client Libraries.
Java
To learn how to install and use the client library for Cloud DLP, see the Cloud DLP Client Libraries.
Node.js
To learn how to install and use the client library for Cloud DLP, see the Cloud DLP Client Libraries.
PHP
To learn how to install and use the client library for Cloud DLP, see the Cloud DLP Client Libraries.
Python
To learn how to install and use the client library for Cloud DLP, see the Cloud DLP Client Libraries.