Uses Cloud DLP to inspect an image for sensitive data.
Explore further
For detailed documentation that includes this code sample, see the following:
Code sample
C#
To learn how to install and use the client library for Sensitive Data Protection, see Sensitive Data Protection client libraries .
To authenticate to Sensitive Data Protection, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
using
System
;
using
System.Collections.Generic
;
using
System.IO
;
using
System.Linq
;
using
Google.Api.Gax.ResourceNames
;
using
Google.Cloud.Dlp.V2
;
using
Google.Protobuf
;
public
class
InspectImage
{
public
static
InspectContentResponse
Inspect
(
string
projectId
,
string
filePath
,
IEnumerable<InfoType>
infoTypes
=
null
)
{
// Instantiate dlp client.
var
dlp
=
DlpServiceClient
.
Create
();
// Construct the content item by setting the type of image and data to be inspected.
var
contentItem
=
new
ContentItem
{
ByteItem
=
new
ByteContentItem
{
Type
=
ByteContentItem
.
Types
.
BytesType
.
ImagePng
,
Data
=
ByteString
.
FromStream
(
new
FileStream
(
filePath
,
FileMode
.
Open
))
}
};
// Construct the Inspect config by specifying the type of info to be inspected.
var
inspectConfig
=
new
InspectConfig
{
InfoTypes
=
{
infoTypes
??
new
InfoType
[]
{
new
InfoType
{
Name
=
"PHONE_NUMBER"
},
new
InfoType
{
Name
=
"EMAIL_ADDRESS"
},
new
InfoType
{
Name
=
"CREDIT_CARD_NUMBER"
}
}
},
IncludeQuote
=
true
};
// Construct the request.
var
request
=
new
InspectContentRequest
{
ParentAsLocationName
=
new
LocationName
(
projectId
,
"global"
),
InspectConfig
=
inspectConfig
,
Item
=
contentItem
};
// Call the API.
InspectContentResponse
response
=
dlp
.
InspectContent
(
request
);
// Inspect the response.
var
resultFindings
=
response
.
Result
.
Findings
;
Console
.
WriteLine
(
$"Findings: {resultFindings.Count}\n"
);
// Print the results.
foreach
(
var
f
in
resultFindings
)
{
var
data
=
from
location
in
f
.
Location
.
ContentLocations
from
b
in
location
.
ImageLocation
.
BoundingBoxes
select
new
{
b
.
Height
,
b
.
Width
,
b
.
Top
,
b
.
Left
};
Console
.
WriteLine
(
"Info type: "
+
f
.
InfoType
.
Name
);
Console
.
WriteLine
(
"\tQuote: "
+
f
.
Quote
);
Console
.
WriteLine
(
"\tImageLocations: "
+
string
.
Join
(
","
,
data
));
Console
.
WriteLine
(
"\tLikelihood: "
+
f
.
Likelihood
);
}
return
response
;
}
}
Go
To learn how to install and use the client library for Sensitive Data Protection, see Sensitive Data Protection client libraries .
To authenticate to Sensitive Data Protection, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
import
(
"context"
"fmt"
"io"
"os"
dlp
"cloud.google.com/go/dlp/apiv2"
"cloud.google.com/go/dlp/apiv2/dlppb"
)
// inspectImageFile inspects an image file for sensitive data
func
inspectImageFile
(
w
io
.
Writer
,
projectID
,
filePath
string
)
error
{
// projectId := "my-project-id"
// filePath := "inspect/testdata/test.png"
ctx
:=
context
.
Background
()
// Initialize a client once and reuse it to send multiple requests. Clients
// are safe to use across goroutines. When the client is no longer needed,
// call the Close method to cleanup its resources.
client
,
err
:=
dlp
.
NewClient
(
ctx
)
if
err
!=
nil
{
return
err
}
// Closing the client safely cleans up background resources.
defer
client
.
Close
()
// Read a image file
data
,
err
:=
os
.
ReadFile
(
filePath
)
if
err
!=
nil
{
return
err
}
// Specify the type and content to be inspected.
item
:=
& dlppb
.
ContentItem
{
DataItem
:
& dlppb
.
ContentItem_ByteItem
{
ByteItem
:
& dlppb
.
ByteContentItem
{
Type
:
dlppb
.
ByteContentItem_IMAGE
,
Data
:
data
,
},
},
}
// Construct the configuration for the Inspect request.
inspectConfig
:=
& dlppb
.
InspectConfig
{
InfoTypes
:
[]
*
dlppb
.
InfoType
{
{
Name
:
"PHONE_NUMBER"
},
{
Name
:
"EMAIL_ADDRESS"
},
{
Name
:
"CREDIT_CARD_NUMBER"
},
},
IncludeQuote
:
true
,
}
// Construct the Inspect request to be sent by the client.
req
:=
& dlppb
.
InspectContentRequest
{
Parent
:
fmt
.
Sprintf
(
"projects/%s/locations/global"
,
projectID
),
Item
:
item
,
InspectConfig
:
inspectConfig
,
}
// Send the request.
resp
,
err
:=
client
.
InspectContent
(
ctx
,
req
)
if
err
!=
nil
{
return
err
}
// Process the results.
fmt
.
Fprintf
(
w
,
"Findings: %d\n"
,
len
(
resp
.
Result
.
Findings
))
for
_
,
f
:=
range
resp
.
Result
.
Findings
{
fmt
.
Fprintf
(
w
,
"\tQuote: %s\n"
,
f
.
Quote
)
fmt
.
Fprintf
(
w
,
"\tInfo type: %s\n"
,
f
.
InfoType
.
Name
)
fmt
.
Fprintf
(
w
,
"\tLikelihood: %s\n"
,
f
.
Likelihood
)
}
return
nil
}
Java
To learn how to install and use the client library for Sensitive Data Protection, see Sensitive Data Protection client libraries .
To authenticate to Sensitive Data Protection, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
import
com.google.cloud.dlp.v2. DlpServiceClient
;
import
com.google.privacy.dlp.v2. ByteContentItem
;
import
com.google.privacy.dlp.v2. ByteContentItem
. BytesType
;
import
com.google.privacy.dlp.v2. ContentItem
;
import
com.google.privacy.dlp.v2. Finding
;
import
com.google.privacy.dlp.v2. InfoType
;
import
com.google.privacy.dlp.v2. InspectConfig
;
import
com.google.privacy.dlp.v2. InspectContentRequest
;
import
com.google.privacy.dlp.v2. InspectContentResponse
;
import
com.google.privacy.dlp.v2. LocationName
;
import
com.google.protobuf. ByteString
;
import
java.io.FileInputStream
;
import
java.io.IOException
;
import
java.util.ArrayList
;
import
java.util.List
;
public
class
InspectImageFile
{
public
static
void
main
(
String
[]
args
)
throws
Exception
{
// TODO(developer): Replace these variables before running the sample.
String
projectId
=
"your-project-id"
;
String
filePath
=
"path/to/image.png"
;
inspectImageFile
(
projectId
,
filePath
);
}
// Inspects the specified image file.
public
static
void
inspectImageFile
(
String
projectId
,
String
filePath
)
throws
IOException
{
// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests. After completing all of your requests, call
// the "close" method on the client to safely clean up any remaining background resources.
try
(
DlpServiceClient
dlp
=
DlpServiceClient
.
create
())
{
// Specify the type and content to be inspected.
ByteString
fileBytes
=
ByteString
.
readFrom
(
new
FileInputStream
(
filePath
));
ByteContentItem
byteItem
=
ByteContentItem
.
newBuilder
().
setType
(
BytesType
.
IMAGE
).
setData
(
fileBytes
).
build
();
ContentItem
item
=
ContentItem
.
newBuilder
().
setByteItem
(
byteItem
).
build
();
// Specify the type of info the inspection will look for.
List<InfoType>
infoTypes
=
new
ArrayList
<> ();
// See https://cloud.google.com/dlp/docs/infotypes-reference for complete list of info types
for
(
String
typeName
:
new
String
[]
{
"PHONE_NUMBER"
,
"EMAIL_ADDRESS"
,
"CREDIT_CARD_NUMBER"
})
{
infoTypes
.
add
(
InfoType
.
newBuilder
().
setName
(
typeName
).
build
());
}
// Construct the configuration for the Inspect request.
InspectConfig
config
=
InspectConfig
.
newBuilder
().
addAllInfoTypes
(
infoTypes
).
setIncludeQuote
(
true
).
build
();
// Construct the Inspect request to be sent by the client.
InspectContentRequest
request
=
InspectContentRequest
.
newBuilder
()
.
setParent
(
LocationName
.
of
(
projectId
,
"global"
).
toString
())
.
setItem
(
item
)
.
setInspectConfig
(
config
)
.
build
();
// Use the client to send the API request.
InspectContentResponse
response
=
dlp
.
inspectContent
(
request
);
// Parse the response and process results.
System
.
out
.
println
(
"Findings: "
+
response
.
getResult
().
getFindingsCount
());
for
(
Finding
f
:
response
.
getResult
().
getFindingsList
())
{
System
.
out
.
println
(
"\tQuote: "
+
f
.
getQuote
());
System
.
out
.
println
(
"\tInfo type: "
+
f
.
getInfoType
().
getName
());
System
.
out
.
println
(
"\tLikelihood: "
+
f
.
getLikelihood
());
}
}
}
}
Node.js
To learn how to install and use the client library for Sensitive Data Protection, see Sensitive Data Protection client libraries .
To authenticate to Sensitive Data Protection, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
// Imports the Google Cloud Data Loss Prevention library
const
DLP
=
require
(
' @google-cloud/dlp
'
);
const
mime
=
require
(
'mime'
);
const
fs
=
require
(
'fs'
);
// Instantiates a client
const
dlp
=
new
DLP
.
DlpServiceClient
();
// The project ID to run the API call under
// const imagePath = './test.jpeg';
// InfoTypes
const
infoTypes
=
[
{
name
:
'PHONE_NUMBER'
},
{
name
:
'EMAIL_ADDRESS'
},
{
name
:
'CREDIT_CARD_NUMBER'
},
];
async
function
inspectImageFile
()
{
let
fileBytes
=
null
;
let
fileTypeConstant
=
null
;
try
{
// Load Image
fileTypeConstant
=
[
'image/jpeg'
,
'image/bmp'
,
'image/png'
,
'image/svg'
].
indexOf
(
mime
.
getType
(
imagePath
)
)
+
1
;
fileBytes
=
Buffer
.
from
(
fs
.
readFileSync
(
imagePath
)).
toString
(
'base64'
);
}
catch
(
error
)
{
console
.
log
(
error
);
return
;
}
// Specify item to inspect
const
item
=
{
byteItem
:
{
type
:
fileTypeConstant
,
data
:
fileBytes
,
},
};
// Specify inspect configuration to match information with mentioned infotypes.
const
inspectConfig
=
{
infoTypes
:
infoTypes
,
includeQuote
:
true
,
};
// Combine configurations into a request for the service.
const
request
=
{
parent
:
`projects/
${
projectId
}
/locations/global`
,
inspectConfig
:
inspectConfig
,
item
:
item
,
};
// Use the client to send the request.
const
[
response
]
=
await
dlp
.
inspectContent
(
request
);
// Print Findings
const
findings
=
response
.
result
.
findings
;
if
(
findings
.
length
>
0
)
{
console
.
log
(
`Findings:
${
findings
.
length
}
\n`
);
findings
.
forEach
(
finding
=
>
{
console
.
log
(
`InfoType:
${
finding
.
infoType
.
name
}
`
);
console
.
log
(
`\tQuote:
${
finding
.
quote
}
`
);
console
.
log
(
`\tLikelihood:
${
finding
.
likelihood
}
\n`
);
});
}
else
{
console
.
log
(
'No findings.'
);
}
}
inspectImageFile
();
PHP
To learn how to install and use the client library for Sensitive Data Protection, see Sensitive Data Protection client libraries .
To authenticate to Sensitive Data Protection, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
use Google\Cloud\Dlp\V2\ByteContentItem;
use Google\Cloud\Dlp\V2\ByteContentItem\BytesType;
use Google\Cloud\Dlp\V2\Client\DlpServiceClient;
use Google\Cloud\Dlp\V2\ContentItem;
use Google\Cloud\Dlp\V2\InfoType;
use Google\Cloud\Dlp\V2\InspectConfig;
use Google\Cloud\Dlp\V2\InspectContentRequest;
use Google\Cloud\Dlp\V2\Likelihood;
/**
* @param string $projectId
* @param string $filepath
*/
function inspect_image_file(string $projectId, string $filepath): void
{
// Instantiate a client.
$dlp = new DlpServiceClient();
// Get the bytes of the file
$fileBytes = (new ByteContentItem())
->setType(BytesType::IMAGE_PNG)
->setData(file_get_contents($filepath));
// Construct request
$parent = "projects/$projectId/locations/global";
$item = (new ContentItem())
->setByteItem($fileBytes);
$inspectConfig = (new InspectConfig())
// The infoTypes of information to match
->setInfoTypes([
(new InfoType())->setName('PHONE_NUMBER'),
(new InfoType())->setName('EMAIL_ADDRESS'),
(new InfoType())->setName('CREDIT_CARD_NUMBER')
])
// Whether to include the matching string
->setIncludeQuote(true);
// Run request
$inspectContentRequest = (new InspectContentRequest())
->setParent($parent)
->setInspectConfig($inspectConfig)
->setItem($item);
$response = $dlp->inspectContent($inspectContentRequest);
// Print the results
$findings = $response->getResult()->getFindings();
if (count($findings) == 0) {
print('No findings.' . PHP_EOL);
} else {
print('Findings:' . PHP_EOL);
foreach ($findings as $finding) {
print(' Quote: ' . $finding->getQuote() . PHP_EOL);
print(' Info type: ' . $finding->getInfoType()->getName() . PHP_EOL);
$likelihoodString = Likelihood::name($finding->getLikelihood());
print(' Likelihood: ' . $likelihoodString . PHP_EOL);
}
}
}
Python
To learn how to install and use the client library for Sensitive Data Protection, see Sensitive Data Protection client libraries .
To authenticate to Sensitive Data Protection, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .
import
google.cloud.dlp
def
inspect_image_file
(
project
:
str
,
filename
:
str
,
include_quote
:
bool
=
True
,
)
-
> None
:
"""Uses the Data Loss Prevention API to analyze strings for
protected data in image file.
Args:
project: The Google Cloud project id to use as a parent resource.
filename: The path to the file to inspect.
include_quote: Boolean for whether to display a quote of the detected
information in the results.
"""
# Instantiate a client.
dlp
=
google
.
cloud
.
dlp_v2
.
DlpServiceClient
()
# Prepare info_types by converting the list of strings into a list of
# dictionaries.
info_types
=
[
"PHONE_NUMBER"
,
"EMAIL_ADDRESS"
,
"CREDIT_CARD_NUMBER"
]
info_types
=
[{
"name"
:
info_type
}
for
info_type
in
info_types
]
# Construct the configuration for the Inspect request.
inspect_config
=
{
"info_types"
:
info_types
,
"include_quote"
:
include_quote
,
}
# Construct the byte_item, containing the image file's byte data.
with
open
(
filename
,
mode
=
"rb"
)
as
f
:
byte_item
=
{
"type_"
:
"IMAGE"
,
"data"
:
f
.
read
()}
# Convert the project id into a full resource id.
parent
=
f
"projects/
{
project
}
/locations/global"
# Call the API.
response
=
dlp
.
inspect_content
(
request
=
{
"parent"
:
parent
,
"inspect_config"
:
inspect_config
,
"item"
:
{
"byte_item"
:
byte_item
},
}
)
# Parse the response and process results.
if
response
.
result
.
findings
:
for
finding
in
response
.
result
.
findings
:
print
(
f
"Quote:
{
finding
.
quote
}
"
)
print
(
f
"Info type:
{
finding
.
info_type
.
name
}
"
)
print
(
f
"Likelihood:
{
finding
.
likelihood
}
"
)
else
:
print
(
"No findings."
)
What's next
To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .
