Cloud Data Loss Prevention (Cloud DLP) fait désormais partie de la protection des données sensibles. Le nom de l'API reste le même: API Cloud Data Loss Prevention (DLP). Pour en savoir plus sur les services qui constituent Sensitive Data Protection, consultez la section Présentation de Sensitive Data Protection.

Google utilise la technologie IA pour traduire le contenu dans votre langue préférée. Les traductions générées par IA peuvent contenir des erreurs.

Créer un détecteur de dictionnaire personnalisé de grande taille

Cette rubrique explique comment créer et recompiler des dictionnaires personnalisés volumineux. Il couvre également plusieurs scénarios d'erreur.

Quand choisir un dictionnaire personnalisé de grande taille plutôt qu'un dictionnaire personnalisé standard ?

Les détecteurs de dictionnaire personnalisé standards sont suffisants lorsque vous souhaitez analyser votre contenu pour détecter des dizaines de milliers de mots ou d'expressions sensibles. Si vous en avez plus ou si votre liste de termes change fréquemment, envisagez de créer un dictionnaire personnalisé volumineux, qui peut accepter des dizaines de millions de termes.

Différences entre les dictionnaires personnalisés de grande taille et les autres infoTypes personnalisés

Les dictionnaires personnalisés de grande taille diffèrent des autres infoTypes personnalisés, car chacun d'eux comporte deux composants :

Une liste d'expressions que vous créez et définissez. Cette liste est stockée sous forme de fichier texte dans Cloud Storage ou de colonne dans une table BigQuery.
Les fichiers de dictionnaire, que Sensitive Data Protection génère et stocke dans Cloud Storage. Les fichiers de dictionnaire sont composés d'une copie de votre liste de termes et de filtres de Bloom, qui facilitent la recherche et la mise en correspondance.

Créer un dictionnaire personnalisé de grande taille

Cette section explique comment créer, modifier et recompiler un dictionnaire personnalisé volumineux.

Créer une liste de termes

Créez une liste contenant tous les mots et expressions que le nouveau détecteur d'infoType doit rechercher. Effectuez l'une des opérations suivantes :

Vous pouvez placer dans un bucket Cloud Storage un fichier texte où chaque mot ou expression figure sur une ligne individuelle.
Désignez une colonne d'une table BigQuery comme conteneur pour les mots et les expressions. Indiquez chaque entrée sur une ligne distincte dans la colonne. Vous pouvez utiliser une table BigQuery existante, à condition que tous les mots et expressions du dictionnaire se trouvent dans une seule colonne.

Il est possible d'assembler une liste de termes trop volumineuse pour être traitée par Sensitive Data Protection. Si un message d'erreur s'affiche, consultez la section Dépannage des erreurs plus loin dans ce sujet.

Créer un infoType stocké

Après avoir créé votre liste de termes, utilisez Sensitive Data Protection pour créer un dictionnaire :

Console

Dans un bucket Cloud Storage, créez un dossier dans lequel Sensitive Data Protection stockera le dictionnaire généré.

Sensitive Data Protection crée des dossiers contenant les fichiers de dictionnaire à l'emplacement que vous spécifiez.
Dans la console Google Cloud , accédez à la page Créer un infoType.

Accéder à la page "Créer un infoType"
Pour Type, sélectionnez Grand dictionnaire personnalisé.
Dans le champ ID de l'infoType, saisissez un identifiant pour l'infoType stocké.

Vous utiliserez cet identifiant lors de la configuration de vos jobs d'inspection et d'anonymisation. Vous pouvez utiliser des lettres, des chiffres, des traits d'union et des traits de soulignement dans le nom.
Dans le champ Nom à afficher de l'infoType, saisissez un nom pour l'infoType stocké.

Vous pouvez utiliser des espaces et des signes de ponctuation.
Dans le champ Description, saisissez une description de ce que votre infoType stocké détecte.
Pour Type de stockage, sélectionnez l'emplacement de votre liste de termes :
- BigQuery : saisissez l'ID du projet, l'ID de l'ensemble de données et l'ID de la table. Dans le champ Nom du champ, saisissez l'identifiant de la colonne. Vous ne pouvez désigner qu'une seule colonne de la table.
- Google Cloud Storage : saisissez le chemin d'accès au fichier.
Dans le champ Bucket ou dossier de sortie, saisissez l'emplacement Cloud Storage du dossier que vous avez créé à l'étape 1.

Remarque : Ne placez pas de fichiers dans les dossiers créés par Sensitive Data Protection lors de la création de votre dictionnaire. Lorsque Sensitive Data Protection crée ou recrée des fichiers de dictionnaire, il supprime tous les autres fichiers stockés dans les dossiers qu'il crée. Tous les dossiers situés au même niveau que ceux créés par Sensitive Data Protection sont conservés.
Cliquez sur Créer.

Un résumé de l'infoType stocké s'affiche. Une fois le dictionnaire généré et le nouvel infoType stocké prêt à être utilisé, l'état de l'infoType est Prêt.

C#

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.

Pour vous authentifier auprès de Sensitive Data Protection, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.


using System;
using Google.Api.Gax.ResourceNames;
using Google.Cloud.Dlp.V2;

public class CreateStoredInfoTypes
{
    public static StoredInfoType Create(
        string projectId,
        string outputPath,
        string storedInfoTypeId)
    {
        // Instantiate the dlp client.
        var dlp = DlpServiceClient.Create();

        // Construct the stored infotype config by specifying the public table and 
        // cloud storage output path.
        var storedInfoTypeConfig = new StoredInfoTypeConfig
        {
            DisplayName = "Github Usernames",
            Description = "Dictionary of Github usernames used in commits.",
            LargeCustomDictionary = new LargeCustomDictionaryConfig
            {
                BigQueryField = new BigQueryField
                {
                    Table = new BigQueryTable
                    {
                        DatasetId = "samples",
                        ProjectId = "bigquery-public-data",
                        TableId = "github_nested"
                    },
                    Field = new FieldId
                    {
                        Name = "actor"
                    }
                },
                OutputPath = new CloudStoragePath
                {
                    Path = outputPath
                }
            },
        };

        // Construct the request.
        var request = new CreateStoredInfoTypeRequest
        {
            ParentAsLocationName = new LocationName(projectId, "global"),
            Config = storedInfoTypeConfig,
            StoredInfoTypeId = storedInfoTypeId
        };

        // Call the API.
        StoredInfoType response = dlp.CreateStoredInfoType(request);

        // Inspect the response.
        Console.WriteLine($"Created the stored infotype at path: {response.Name}");

        return response;
    }
}

Go

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.

import (
	"context"
	"fmt"
	"io"

	dlp "cloud.google.com/go/dlp/apiv2"
	"cloud.google.com/go/dlp/apiv2/dlppb"
)

// createStoredInfoType creates a custom stored info type based on your input data.
func createStoredInfoType(w io.Writer, projectID, outputPath string) error {
	// projectId := "my-project-id"
	// outputPath := "gs://" + "your-bucket-name" + "path/to/directory"

	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()

	// Specify the name you want to give the dictionary.
	displayName := "Github Usernames"

	// Specify a description of the dictionary.
	description := "Dictionary of GitHub usernames used in commits"

	// Specify the path to the location in a Cloud Storage
	// bucket to store the created dictionary.
	cloudStoragePath := &dlppb.CloudStoragePath{
		Path: outputPath,
	}

	// Specify your term list is stored in BigQuery.
	bigQueryField := &dlppb.BigQueryField{
		Table: &dlppb.BigQueryTable{
			ProjectId: "bigquery-public-data",
			DatasetId: "samples",
			TableId:   "github_nested",
		},
		Field: &dlppb.FieldId{
			Name: "actor",
		},
	}

	// Specify the configuration of the large custom dictionary.
	largeCustomDictionaryConfig := &dlppb.LargeCustomDictionaryConfig{
		OutputPath: cloudStoragePath,
		Source: &dlppb.LargeCustomDictionaryConfig_BigQueryField{
			BigQueryField: bigQueryField,
		},
	}

	// Specify the configuration for stored infoType.
	storedInfoTypeConfig := &dlppb.StoredInfoTypeConfig{
		DisplayName: displayName,
		Description: description,
		Type: &dlppb.StoredInfoTypeConfig_LargeCustomDictionary{
			LargeCustomDictionary: largeCustomDictionaryConfig,
		},
	}

	// Combine configurations into a request for the service.
	req := &dlppb.CreateStoredInfoTypeRequest{
		Parent:           fmt.Sprintf("projects/%s/locations/global", projectID),
		Config:           storedInfoTypeConfig,
		StoredInfoTypeId: "github-usernames",
	}

	// Send the request and receive response from the service.
	resp, err := client.CreateStoredInfoType(ctx, req)
	if err != nil {
		return err
	}

	// Print the result.
	fmt.Fprintf(w, "output: %v", resp.Name)
	return nil

}

Java

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.


import com.google.cloud.dlp.v2.DlpServiceClient;
import com.google.privacy.dlp.v2.BigQueryField;
import com.google.privacy.dlp.v2.BigQueryTable;
import com.google.privacy.dlp.v2.CloudStoragePath;
import com.google.privacy.dlp.v2.CreateStoredInfoTypeRequest;
import com.google.privacy.dlp.v2.FieldId;
import com.google.privacy.dlp.v2.LargeCustomDictionaryConfig;
import com.google.privacy.dlp.v2.LocationName;
import com.google.privacy.dlp.v2.StoredInfoType;
import com.google.privacy.dlp.v2.StoredInfoTypeConfig;
import java.io.IOException;

public class CreateStoredInfoType {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.

    //The Google Cloud project id to use as a parent resource.
    String projectId = "your-project-id";
    // The path to the location in a GCS bucket to store the created dictionary.
    String outputPath = "gs://" + "your-bucket-name" + "path/to/directory";
    createStoredInfoType(projectId, outputPath);
  }

  // Creates a custom stored info type that contains GitHub usernames used in commits.
  public static void createStoredInfoType(String projectId, String outputPath)
      throws IOException {
    try (DlpServiceClient dlp = DlpServiceClient.create()) {

      // Optionally set a display name and a description.
      String displayName = "GitHub usernames";
      String description = "Dictionary of GitHub usernames used in commits";

      // The output path where the custom dictionary containing the GitHub usernames will be stored.
      CloudStoragePath cloudStoragePath =
          CloudStoragePath.newBuilder()
              .setPath(outputPath)
              .build();

      // The reference to the table containing the GitHub usernames.
      BigQueryTable table = BigQueryTable.newBuilder()
              .setProjectId("bigquery-public-data")
              .setDatasetId("samples")
              .setTableId("github_nested")
              .build();

      // The reference to the BigQuery field that contains the GitHub usernames.
      BigQueryField bigQueryField = BigQueryField.newBuilder()
              .setTable(table)
              .setField(FieldId.newBuilder().setName("actor").build())
              .build();

      LargeCustomDictionaryConfig largeCustomDictionaryConfig =
          LargeCustomDictionaryConfig.newBuilder()
              .setOutputPath(cloudStoragePath)
              .setBigQueryField(bigQueryField)
              .build();

      StoredInfoTypeConfig storedInfoTypeConfig = StoredInfoTypeConfig.newBuilder()
              .setDisplayName(displayName)
              .setDescription(description)
              .setLargeCustomDictionary(largeCustomDictionaryConfig)
              .build();

      // Combine configurations into a request for the service.
      CreateStoredInfoTypeRequest createStoredInfoType = CreateStoredInfoTypeRequest.newBuilder()
              .setParent(LocationName.of(projectId, "global").toString())
              .setConfig(storedInfoTypeConfig)
              .setStoredInfoTypeId("github-usernames")
              .build();

      // Send the request and receive response from the service.
      StoredInfoType response = dlp.createStoredInfoType(createStoredInfoType);

      // Print the results.
      System.out.println("Created Stored InfoType: " + response.getName());
    }
  }
}

Node.js

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.

// Import the required libraries
const dlp = require('@google-cloud/dlp');

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

// The project ID to run the API call under.
// const projectId = "your-project-id";

// The identifier for the stored infoType
// const infoTypeId = 'github-usernames';

// The path to the location in a Cloud Storage bucket to store the created dictionary
// const outputPath = 'cloud-bucket-path';

// The project ID the table is stored under
// This may or (for public datasets) may not equal the calling project ID
// const dataProjectId = 'my-project';

// The ID of the dataset to inspect, e.g. 'my_dataset'
// const datasetId = 'my_dataset';

// The ID of the table to inspect, e.g. 'my_table'
// const tableId = 'my_table';

// Field ID to be used for constructing dictionary
// const fieldName = 'field_name';

async function createStoredInfoType() {
  // The name you want to give the dictionary.
  const displayName = 'GitHub usernames';
  // A description of the dictionary.
  const description = 'Dictionary of GitHub usernames used in commits';

  // Specify configuration for the large custom dictionary
  const largeCustomDictionaryConfig = {
    outputPath: {
      path: outputPath,
    },
    bigQueryField: {
      table: {
        datasetId: datasetId,
        projectId: dataProjectId,
        tableId: tableId,
      },
      field: {
        name: fieldName,
      },
    },
  };

  // Stored infoType configuration that uses large custom dictionary.
  const storedInfoTypeConfig = {
    displayName: displayName,
    description: description,
    largeCustomDictionary: largeCustomDictionaryConfig,
  };

  // Construct the job creation request to be sent by the client.
  const request = {
    parent: `projects/${projectId}/locations/global`,
    config: storedInfoTypeConfig,
    storedInfoTypeId: infoTypeId,
  };

  // Send the job creation request and process the response.
  const [response] = await dlpClient.createStoredInfoType(request);

  // Print results
  console.log(`InfoType stored successfully: ${response.name}`);
}
await createStoredInfoType();

PHP

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.


use Google\Cloud\Dlp\V2\BigQueryField;
use Google\Cloud\Dlp\V2\BigQueryTable;
use Google\Cloud\Dlp\V2\Client\DlpServiceClient;
use Google\Cloud\Dlp\V2\CloudStoragePath;
use Google\Cloud\Dlp\V2\CreateStoredInfoTypeRequest;
use Google\Cloud\Dlp\V2\FieldId;
use Google\Cloud\Dlp\V2\LargeCustomDictionaryConfig;
use Google\Cloud\Dlp\V2\StoredInfoTypeConfig;

/**
 * Create a stored infoType.
 *
 * @param string $callingProjectId  The Google Cloud Project ID to run the API call under.
 * @param string $outputgcsPath     The path to the location in a Cloud Storage bucket to store the created dictionary.
 * @param string $storedInfoTypeId  The name of the custom stored info type.
 * @param string $displayName       The human-readable name to give the stored infoType.
 * @param string $description       A description for the stored infoType to be created.
 */
function create_stored_infotype(
    string $callingProjectId,
    string $outputgcsPath,
    string $storedInfoTypeId,
    string $displayName,
    string $description
): void {
    // Instantiate a client.
    $dlp = new DlpServiceClient();

    // The reference to the table containing the GitHub usernames.
    // The reference to the BigQuery field that contains the GitHub usernames.
    // Note: we have used public data
    $bigQueryField = (new BigQueryField())
        ->setTable((new BigQueryTable())
            ->setDatasetId('samples')
            ->setProjectId('bigquery-public-data')
            ->setTableId('github_nested'))
        ->setField((new FieldId())
            ->setName('actor'));

    $largeCustomDictionaryConfig = (new LargeCustomDictionaryConfig())
        // The output path where the custom dictionary containing the GitHub usernames will be stored.
        ->setOutputPath((new CloudStoragePath())
            ->setPath($outputgcsPath))
        ->setBigQueryField($bigQueryField);

    // Configure the StoredInfoType we want the service to perform.
    $storedInfoTypeConfig = (new StoredInfoTypeConfig())
        ->setDisplayName($displayName)
        ->setDescription($description)
        ->setLargeCustomDictionary($largeCustomDictionaryConfig);

    // Send the stored infoType creation request and process the response.
    $parent = "projects/$callingProjectId/locations/global";
    $createStoredInfoTypeRequest = (new CreateStoredInfoTypeRequest())
        ->setParent($parent)
        ->setConfig($storedInfoTypeConfig)
        ->setStoredInfoTypeId($storedInfoTypeId);
    $response = $dlp->createStoredInfoType($createStoredInfoTypeRequest);

    // Print results.
    printf('Successfully created Stored InfoType : %s', $response->getName());
}

Python

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.

import google.cloud.dlp


def create_stored_infotype(
    project: str,
    stored_info_type_id: str,
    output_bucket_name: str,
) -> None:
    """Uses the Data Loss Prevention API to create stored infoType.
    Args:
        project: The Google Cloud project id to use as a parent resource.
        stored_info_type_id: The identifier for large custom dictionary.
        output_bucket_name: The name of the bucket in Google Cloud Storage
            that would store the created dictionary.
    """

    # Instantiate a client.
    dlp = google.cloud.dlp_v2.DlpServiceClient()

    # Construct the stored infoType Configuration dictionary. This example creates
    # a stored infoType from a term list stored in a publicly available BigQuery
    # database (bigquery-public-data.samples.github_nested).
    # The database contains all GitHub usernames used in commits.
    stored_info_type_config = {
        "display_name": "GitHub usernames",
        "description": "Dictionary of GitHub usernames used in commits",
        "large_custom_dictionary": {
            "output_path": {"path": f"gs://{output_bucket_name}"},
            # We can either use bigquery field or gcs file as a term list input option.
            "big_query_field": {
                "table": {
                    "project_id": "bigquery-public-data",
                    "dataset_id": "samples",
                    "table_id": "github_nested",
                },
                "field": {"name": "actor"},
            },
        },
    }

    # Convert the project id into a full resource id.
    parent = f"projects/{project}/locations/global"

    # Call the API.
    response = dlp.create_stored_info_type(
        request={
            "parent": parent,
            "config": stored_info_type_config,
            "stored_info_type_id": stored_info_type_id,
        }
    )

    # Print the result
    print(f"Created Stored InfoType: {response.name}")

REST

Créez un dossier pour le dictionnaire dans un bucket Cloud Storage. Sensitive Data Protection crée des dossiers contenant les fichiers de dictionnaire à l'emplacement que vous spécifiez.

Créez le dictionnaire à l'aide de la méthode storedInfoTypes.create. La méthode create utilise les paramètres suivants :
- Un objet StoredInfoTypeConfig, qui contient la configuration de l'infoType stocké. Il inclut les éléments suivants :
  - description : la description du dictionnaire.
  - displayName : le nom que vous souhaitez donner au dictionnaire.
  - LargeCustomDictionaryConfig : contient la configuration du dictionnaire personnalisé volumineux. Il inclut les éléments suivants :
    - BigQueryField : spécifié si la liste de termes est stockée dans BigQuery. Inclut une référence à la table dans laquelle votre liste est stockée, ainsi que le champ contenant chaque expression du dictionnaire.
    - CloudStorageFileSet : spécifié si la liste de termes est stockée dans Cloud Storage. Comprend l'URL de l'emplacement source dans Cloud Storage, au format suivant : "gs://[PATH_TO_GS]". Les caractères génériques sont acceptés.
    - outputPath : chemin de l'emplacement au sein d'un bucket Cloud Storage où sera stocké le dictionnaire créé.
- storedInfoTypeId : identifiant de l'infoType stocké. Vous utilisez cet identifiant pour faire référence à l'infoType stocké lorsque vous le recréez, le supprimez ou l'utilisez dans un job d'inspection ou d'anonymisation. Si vous laissez ce champ vide, le système génère un identifiant pour vous.

Voici un exemple de code JSON qui, lorsqu'il est envoyé à la méthode storedInfoTypes.create, crée un infoType stocké, plus précisément un détecteur de dictionnaire personnalisé volumineux. Cet exemple crée un infoType stocké à partir d'une liste de termes stockée dans une base de données BigQuery accessible au public (bigquery-public-data.samples.github_nested). La base de données contient tous les noms d'utilisateur GitHub utilisés dans les commits. Le chemin de sortie du dictionnaire généré est défini sur un bucket Cloud Storage nommé dlptesting, et l'infoType stocké est nommé github-usernames.

Entrée JSON

POST https://dlp.googleapis.com/v2/projects/PROJECT_ID/storedInfoTypes

{
  "config":{
    "displayName":"GitHub usernames",
    "description":"Dictionary of GitHub usernames used in commits",
    "largeCustomDictionary":{
      "outputPath":{
        "path":"gs://[PATH_TO_GS]"
      },
      "bigQueryField":{
        "table":{
          "datasetId":"samples",
          "projectId":"bigquery-public-data",
          "tableId":"github_nested"
        }
      }
    }
  },
  "storedInfoTypeId":"github-usernames"
}

Recompiler le dictionnaire

Si vous souhaitez mettre à jour votre dictionnaire, vous devez d'abord mettre à jour votre liste de termes sources, puis demander à Sensitive Data Protection de recréer l'infoType stocké.

Mettez à jour la liste source de termes existante dans Cloud Storage ou BigQuery.

Ajoutez, supprimez ou modifiez les termes ou expressions selon vos besoins.
Créez une version de l'infoType stocké en le "reconstruisant" à l'aide de la console Google Cloud ou de la méthode storedInfoTypes.patch.

La recompilation crée une nouvelle version du dictionnaire, qui remplace l'ancien dictionnaire.

Lorsque vous recréez un infoType stocké dans une nouvelle version, l'ancienne version est supprimée. Pendant que Sensitive Data Protection met à jour l'infoType stocké, son état est "en attente". Pendant ce temps, l'ancienne version de l'infoType stocké existe toujours. Toutes les analyses que vous exécutez alors que l'infoType stocké est en attente seront exécutées à l'aide de l'ancienne version de l'infoType stocké.

Pour recréer l'infoType stocké :

Console

Mettez à jour et enregistrez votre liste de termes dans Cloud Storage ou BigQuery.
Dans la console Google Cloud , accédez à la liste des infoTypes stockés.

Accéder aux infoTypes stockés
Cliquez sur l'ID de l'infoType stocké que vous souhaitez mettre à jour.
Sur la page Détails de l'infoType, cliquez sur Reconstruire les données.

Sensitive Data Protection recrée l'infoType stocké avec les modifications que vous avez apportées à la liste de termes sources. Une fois que l'état de l'infoType stocké est "Prêt", vous pouvez l'utiliser. Tous les modèles ou déclencheurs de jobs qui utilisent l'infoType stocké utiliseront automatiquement la version recréée.

C#

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.


using System;
using Google.Cloud.Dlp.V2;
using Google.Protobuf.WellKnownTypes;

public class UpdateStoredInfoTypes
{
    public static StoredInfoType Update(
        string gcsFileUri,
        string storedInfoTypePath,
        string outputPath)
    {
        // Instantiate the client.
        var dlp = DlpServiceClient.Create();

        // Construct the stored infotype config. Here, we will change the source from bigquery table to GCS file.
        var storedConfig = new StoredInfoTypeConfig
        {
            LargeCustomDictionary = new LargeCustomDictionaryConfig
            {
                CloudStorageFileSet = new CloudStorageFileSet
                {
                    Url = gcsFileUri
                },
                OutputPath = new CloudStoragePath
                {
                    Path = outputPath
                }
            }
        };

        // Construct the request using the stored config by specifying the update mask object
        // which represent the path of field to be updated.
        var request = new UpdateStoredInfoTypeRequest
        {
            Config = storedConfig,
            Name = storedInfoTypePath,
            UpdateMask = new FieldMask
            {
                Paths =
                {
                    "large_custom_dictionary.cloud_storage_file_set.url"
                }
            }
        };

        // Call the API.
        StoredInfoType response = dlp.UpdateStoredInfoType(request);

        // Inspect the result.
        Console.WriteLine(response);
        return response;
    }
}

Go

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.

import (
	"context"
	"fmt"
	"io"

	dlp "cloud.google.com/go/dlp/apiv2"
	"cloud.google.com/go/dlp/apiv2/dlppb"
	"google.golang.org/protobuf/types/known/fieldmaskpb"
)

// updateStoredInfoType uses the Data Loss Prevention API to update stored infoType
// detector by changing the source term list from one stored in Bigquery
// to one stored in Cloud Storage.
func updateStoredInfoType(w io.Writer, projectID, gcsUri, fileSetUrl, infoTypeId string) error {
	// projectId := "your-project-id"
	// gcsUri := "gs://" + "your-bucket-name" + "/path/to/your/file.txt"
	// fileSetUrl := "your-cloud-storage-file-set"
	// infoTypeId := "your-stored-info-type-id"

	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()

	// Set path in Cloud Storage.
	cloudStoragePath := &dlppb.CloudStoragePath{
		Path: gcsUri,
	}
	cloudStorageFileSet := &dlppb.CloudStorageFileSet{
		Url: fileSetUrl,
	}

	// Configuration for a custom dictionary created from a data source of any size
	largeCustomDictionaryConfig := &dlppb.LargeCustomDictionaryConfig{
		OutputPath: cloudStoragePath,
		Source: &dlppb.LargeCustomDictionaryConfig_CloudStorageFileSet{
			CloudStorageFileSet: cloudStorageFileSet,
		},
	}

	// Set configuration for stored infoTypes.
	storedInfoTypeConfig := &dlppb.StoredInfoTypeConfig{
		Type: &dlppb.StoredInfoTypeConfig_LargeCustomDictionary{
			LargeCustomDictionary: largeCustomDictionaryConfig,
		},
	}

	// Set mask to control which fields get updated.
	fieldMask := &fieldmaskpb.FieldMask{
		Paths: []string{"large_custom_dictionary.cloud_storage_file_set.url"},
	}
	// Construct the job creation request to be sent by the client.
	req := &dlppb.UpdateStoredInfoTypeRequest{
		Name:       fmt.Sprint("projects/" + projectID + "/storedInfoTypes/" + infoTypeId),
		Config:     storedInfoTypeConfig,
		UpdateMask: fieldMask,
	}

	// Use the client to send the API request.
	resp, err := client.UpdateStoredInfoType(ctx, req)
	if err != nil {
		return err
	}

	// Print the result.
	fmt.Fprintf(w, "output: %v", resp.Name)
	return nil
}

Java

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.


import com.google.cloud.dlp.v2.DlpServiceClient;
import com.google.privacy.dlp.v2.CloudStorageFileSet;
import com.google.privacy.dlp.v2.CloudStoragePath;
import com.google.privacy.dlp.v2.LargeCustomDictionaryConfig;
import com.google.privacy.dlp.v2.StoredInfoType;
import com.google.privacy.dlp.v2.StoredInfoTypeConfig;
import com.google.privacy.dlp.v2.StoredInfoTypeName;
import com.google.privacy.dlp.v2.UpdateStoredInfoTypeRequest;
import com.google.protobuf.FieldMask;
import java.io.IOException;

public class UpdateStoredInfoType {
  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    // The Google Cloud project id to use as a parent resource.
    String projectId = "your-project-id";
    // The path to file in GCS bucket that holds a collection of words and phrases to be searched by
    // the new infoType detector.
    String filePath = "gs://" + "your-bucket-name" + "/path/to/your/file.txt";
    // The path to the location in a GCS bucket to store the created dictionary.
    String outputPath = "your-cloud-storage-file-set";
    // The name of the stored InfoType which is to be updated.
    String infoTypeId = "your-stored-info-type-id";
    updateStoredInfoType(projectId, filePath, outputPath, infoTypeId);
  }

  // Update the stored info type rebuilding the Custom dictionary.
  public static void updateStoredInfoType(
      String projectId, String filePath, String outputPath, String infoTypeId) 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()) {
      // Set path in Cloud Storage.
      CloudStoragePath cloudStoragePath = CloudStoragePath.newBuilder().setPath(outputPath).build();
      CloudStorageFileSet cloudStorageFileSet =
          CloudStorageFileSet.newBuilder().setUrl(filePath).build();

      // Configuration for a custom dictionary created from a data source of any size
      LargeCustomDictionaryConfig largeCustomDictionaryConfig =
          LargeCustomDictionaryConfig.newBuilder()
              .setOutputPath(cloudStoragePath)
              .setCloudStorageFileSet(cloudStorageFileSet)
              .build();

      // Set configuration for stored infoTypes.
      StoredInfoTypeConfig storedInfoTypeConfig =
          StoredInfoTypeConfig.newBuilder()
              .setLargeCustomDictionary(largeCustomDictionaryConfig)
              .build();

      // Set mask to control which fields get updated.
      // Refer https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask for constructing the field mask paths.
      FieldMask fieldMask =
          FieldMask.newBuilder()
              .addPaths("large_custom_dictionary.cloud_storage_file_set.url")
              .build();

      // Construct the job creation request to be sent by the client.
      UpdateStoredInfoTypeRequest updateStoredInfoTypeRequest =
          UpdateStoredInfoTypeRequest.newBuilder()
              .setName(
                  StoredInfoTypeName.ofProjectStoredInfoTypeName(projectId, infoTypeId).toString())
              .setConfig(storedInfoTypeConfig)
              .setUpdateMask(fieldMask)
              .build();

      // Send the job creation request and process the response.
      StoredInfoType response = dlp.updateStoredInfoType(updateStoredInfoTypeRequest);

      // Print the results.
      System.out.println("Updated stored InfoType successfully: " + response.getName());
    }
  }
}

Node.js

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.

// Import the required libraries
const dlp = require('@google-cloud/dlp');

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

// The project ID to run the API call under.
// const projectId = "your-project-id";

// The identifier for the stored infoType
// const infoTypeId = 'github-usernames';

// The path to the location in a Cloud Storage bucket to store the created dictionary
// const outputPath = 'cloud-bucket-path';

// Path of file containing term list
// const cloudStorageFileSet = 'gs://[PATH_TO_GS]';

async function updateStoredInfoType() {
  // Specify configuration of the large custom dictionary including cloudStorageFileSet and outputPath
  const largeCustomDictionaryConfig = {
    outputPath: {
      path: outputPath,
    },
    cloudStorageFileSet: {
      url: fileSetUrl,
    },
  };

  // Construct the job creation request to be sent by the client.
  const updateStoredInfoTypeRequest = {
    name: `projects/${projectId}/storedInfoTypes/${infoTypeId}`,
    config: {
      largeCustomDictionary: largeCustomDictionaryConfig,
    },
    updateMask: {
      paths: ['large_custom_dictionary.cloud_storage_file_set.url'],
    },
  };

  // Send the job creation request and process the response.
  const [response] = await dlpClient.updateStoredInfoType(
    updateStoredInfoTypeRequest
  );

  // Print the results.
  console.log(`InfoType updated successfully: ${JSON.stringify(response)}`);
}
await updateStoredInfoType();

PHP

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.

use Google\Cloud\Dlp\V2\Client\DlpServiceClient;
use Google\Cloud\Dlp\V2\CloudStorageFileSet;
use Google\Cloud\Dlp\V2\CloudStoragePath;
use Google\Cloud\Dlp\V2\LargeCustomDictionaryConfig;
use Google\Cloud\Dlp\V2\StoredInfoTypeConfig;
use Google\Cloud\Dlp\V2\UpdateStoredInfoTypeRequest;
use Google\Protobuf\FieldMask;

/**
 * Rebuild/Update the stored infoType.
 *
 * @param string $callingProjectId  The Google Cloud Project ID to run the API call under.
 * @param string $gcsPath           The path to file in GCS bucket that holds a collection of words and phrases to be searched by the new infoType detector.
 * @param string $outputgcsPath     The path to the location in a Cloud Storage bucket to store the created dictionary.
 * @param string $storedInfoTypeId  The name of the stored InfoType which is to be updated.
 *
 */
function update_stored_infotype(
    string $callingProjectId,
    string $gcsPath,
    string $outputgcsPath,
    string $storedInfoTypeId
): void {
    // Instantiate a client.
    $dlp = new DlpServiceClient();

    // Set path in Cloud Storage.
    $cloudStorageFileSet = (new CloudStorageFileSet())
        ->setUrl($gcsPath);

    // Configuration for a custom dictionary created from a data source of any size
    $largeCustomDictionaryConfig = (new LargeCustomDictionaryConfig())
        ->setOutputPath((new CloudStoragePath())
            ->setPath($outputgcsPath))
        ->setCloudStorageFileSet($cloudStorageFileSet);

    // Set configuration for stored infoTypes.
    $storedInfoTypeConfig = (new StoredInfoTypeConfig())
        ->setLargeCustomDictionary($largeCustomDictionaryConfig);

    // Send the stored infoType creation request and process the response.

    $name = "projects/$callingProjectId/locations/global/storedInfoTypes/" . $storedInfoTypeId;
    // Set mask to control which fields get updated.
    // Refer https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask for constructing the field mask paths.
    $fieldMask = (new FieldMask())
        ->setPaths([
            'large_custom_dictionary.cloud_storage_file_set.url'
        ]);

    // Run request
    $updateStoredInfoTypeRequest = (new UpdateStoredInfoTypeRequest())
        ->setName($name)
        ->setConfig($storedInfoTypeConfig)
        ->setUpdateMask($fieldMask);
    $response = $dlp->updateStoredInfoType($updateStoredInfoTypeRequest);

    // Print results
    printf('Successfully update Stored InforType : %s' . PHP_EOL, $response->getName());
}

Python

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.

import google.cloud.dlp


def update_stored_infotype(
    project: str,
    stored_info_type_id: str,
    gcs_input_file_path: str,
    output_bucket_name: str,
) -> None:
    """Uses the Data Loss Prevention API to update stored infoType
    detector by changing the source term list from one stored in Bigquery
    to one stored in Cloud Storage.
    Args:
        project: The Google Cloud project id to use as a parent resource.
        stored_info_type_id: The identifier of stored infoType which is to
            be updated.
        gcs_input_file_path: The url in the format <bucket>/<path_to_file>
            for the location of the source term list.
        output_bucket_name: The name of the bucket in Google Cloud Storage
            where large dictionary is stored.
    """

    # Instantiate a client.
    dlp = google.cloud.dlp_v2.DlpServiceClient()

    # Construct the stored infoType configuration dictionary.
    stored_info_type_config = {
        "large_custom_dictionary": {
            "output_path": {"path": f"gs://{output_bucket_name}"},
            "cloud_storage_file_set": {"url": f"gs://{gcs_input_file_path}"},
        }
    }

    # Set mask to control which fields get updated. For more details, refer
    # https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask
    # for constructing the field mask paths.
    field_mask = {"paths": ["large_custom_dictionary.cloud_storage_file_set.url"]}

    # Convert the stored infoType id into a full resource id.
    stored_info_type_name = (
        f"projects/{project}/locations/global/storedInfoTypes/{stored_info_type_id}"
    )

    # Call the API.
    response = dlp.update_stored_info_type(
        request={
            "name": stored_info_type_name,
            "config": stored_info_type_config,
            "update_mask": field_mask,
        }
    )

    # Print the result
    print(f"Updated stored infoType successfully: {response.name}")

REST

Mettre à jour la liste de termes

Si vous ne mettez à jour que la liste des termes du dictionnaire personnalisé volumineux, votre requête storedInfoTypes.patch ne nécessite que le champ name. Indiquez le nom complet de la ressource de l'infoType stocké que vous souhaitez recompiler.

Les schémas suivants représentent des saisies valides pour le champ name :

organizations/ORGANIZATION_ID/storedInfoTypes/STORED_INFOTYPE_ID
projects/PROJECT_ID/storedInfoTypes/STORED_INFOTYPE_ID

Remplacez STORED_INFOTYPE_ID par l'identifiant de l'infoType stocké que vous souhaitez recréer.

Si vous ne connaissez pas l'identifiant de l'infoType stocké, appelez la méthode storedInfoTypes.list pour afficher la liste de tous les infoTypes stockés actuels.

Exemple

PATCH https://dlp.googleapis.com/v2/projects/PROJECT_ID/storedInfoTypes/STORED_INFOTYPE_ID

Dans ce cas, aucun corps de requête n'est requis.

Changer de liste de termes sources

Vous pouvez remplacer la liste de termes sources d'un infoType stocké par une liste stockée dans Cloud Storage. Utilisez la méthode storedInfoTypes.patch, mais incluez un objet CloudStorageFileSet dans LargeCustomDictionaryConfig où vous aviez utilisé un objet BigQueryField auparavant. Ensuite, définissez le paramètre updateMask sur le paramètre storedInfoType que vous avez recréé, au format FieldMask. Par exemple, le code JSON suivant indique dans le paramètre updateMask que l'URL du chemin d'accès Cloud Storage a été mise à jour (large_custom_dictionary.cloud_storage_file_set.url) :

Exemple

PATCH https://dlp.googleapis.com/v2/projects/PROJECT_ID/storedInfoTypes/github-usernames

{
  "config":{
    "largeCustomDictionary":{
      "cloudStorageFileSet":{
        "url":"gs://[BUCKET_NAME]/[PATH_TO_FILE]"
      }
    }
  },
  "updateMask":"large_custom_dictionary.cloud_storage_file_set.url"
}

De même, vous pouvez remplacer une liste de termes stockée dans une table BigQuery par une liste stockée dans un bucket Cloud Storage.

Analyser du contenu à l'aide d'un détecteur de dictionnaire personnalisé de grande taille

L'analyse de contenu à l'aide d'un détecteur de dictionnaire personnalisé volumineux est semblable à l'analyse de contenu à l'aide de tout autre détecteur d'infoType personnalisé.

Cette procédure suppose que vous disposez déjà d'un infoType stocké. Pour en savoir plus, consultez la section Créer un infoType stocké sur cette page.

Console

Vous pouvez appliquer un détecteur de dictionnaire personnalisé de grande taille lorsque vous effectuez les opérations suivantes :

Créer un job
Créer ou modifier un déclencheur de job
Créer ou modifier un modèle
Configurer le profilage des données

Dans la section Configurer la détection de la page, dans la sous-section InfoTypes, vous pouvez spécifier votre infoType de dictionnaire personnalisé volumineux.

Cliquez sur Gérer les infoTypes.
Dans le volet InfoTypes, cliquez sur l'onglet Personnalisé.
Cliquez sur Ajouter un infoType personnalisé.
Dans le volet Ajouter un infoType personnalisé, procédez comme suit :
1. Pour Type, sélectionnez InfoType stocké.
2. Dans le champ InfoType, saisissez un nom pour l'infoType personnalisé. Vous pouvez utiliser des lettres, des chiffres et des traits de soulignement.
3. Pour Probabilité, sélectionnez le niveau de probabilité par défaut que vous souhaitez attribuer à tous les résultats correspondant à cet infoType personnalisé. Vous pouvez affiner le niveau de probabilité des résultats individuels à l'aide de règles relatives aux mots clés.
  
  Si vous ne spécifiez pas de valeur par défaut, le niveau de probabilité par défaut est défini sur VERY_LIKELY. Pour en savoir plus, consultez Probabilité de correspondance.
4. Pour Sensibilité, sélectionnez le niveau de sensibilité que vous souhaitez attribuer à tous les résultats correspondant à cet infoType personnalisé. Si vous ne spécifiez pas de valeur, les niveaux de sensibilité de ces résultats sont définis sur HIGH.
  
  Les scores de sensibilité sont utilisés dans les profils de données. Lors du profilage de vos données, Sensitive Data Protection utilise les scores de sensibilité des infoTypes pour calculer le niveau de sensibilité.
5. Pour Nom de l'infoType stocké, sélectionnez l'infoType stocké sur lequel vous souhaitez baser le nouvel infoType personnalisé.
6. Cliquez sur OK pour fermer le volet Ajouter un infoType personnalisé.
Facultatif : Dans l'onglet Intégrés, modifiez votre sélection d'infoTypes intégrés.
Cliquez sur OK pour fermer le volet InfoTypes.

L'infoType personnalisé est ajouté à la liste des infoTypes que Sensitive Data Protection recherche. Toutefois, cette sélection n'est pas définitive tant que vous n'avez pas enregistré le job, le déclencheur de job, le modèle ou la configuration d'analyse.
Une fois que vous avez terminé de créer ou de modifier la configuration, cliquez sur Enregistrer.

C#

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.


using System;
using Google.Api.Gax.ResourceNames;
using Google.Cloud.Dlp.V2;

public class InspectDataWithStoredInfotypes
{
    public static InspectContentResponse Inspect(
        string projectId,
        string storedInfotypePath,
        string text,
        InfoType infoType = null)
    {
        // Instantiate the dlp client.
        var dlp = DlpServiceClient.Create();

        // Construct the infotype if null.
        var infotype = infoType ?? new InfoType { Name = "GITHUB_LOGINS" };

        // Construct the inspect config using stored infotype.
        var inspectConfig = new InspectConfig
        {
            CustomInfoTypes =
            {
                new CustomInfoType
                {
                    InfoType = infotype,
                    StoredType = new StoredType { Name = storedInfotypePath }
                }
            },
            IncludeQuote = true
        };

        // Construct the request using inspect config.
        var request = new InspectContentRequest
        {
            ParentAsLocationName = new LocationName(projectId, "global"),
            InspectConfig = inspectConfig,
            Item = new ContentItem { Value = text }
        };

        // Call the API.
        InspectContentResponse response = dlp.InspectContent(request);

        // Inspect the results.
        var findings = response.Result.Findings;
        Console.WriteLine($"Findings: {findings.Count}");
        foreach (var f in findings)
        {
            Console.WriteLine("\tQuote: " + f.Quote);
            Console.WriteLine("\tInfo type: " + f.InfoType.Name);
            Console.WriteLine("\tLikelihood: " + f.Likelihood);
        }

        return response;
    }
}

Go

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.

import (
	"context"
	"fmt"
	"io"

	dlp "cloud.google.com/go/dlp/apiv2"
	"cloud.google.com/go/dlp/apiv2/dlppb"
)

// inspectWithStoredInfotype inspects the given text using the specified stored infoType detector.
func inspectWithStoredInfotype(w io.Writer, projectID, infoTypeId, textToDeidentify string) error {
	// projectId := "your-project-id"
	// infoTypeId := "your-info-type-id"
	// textToDeidentify := "This commit was made by kewin2010"

	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()

	// Specify the content to be inspected.
	contentItem := &dlppb.ContentItem{
		DataItem: &dlppb.ContentItem_Value{
			Value: textToDeidentify,
		},
	}

	// Specify the info type the inspection will look for.
	infoType := &dlppb.InfoType{
		Name: "GITHUB_LOGINS",
	}

	// Specify the stored info type the inspection will look for.
	storedType := &dlppb.StoredType{
		Name: infoTypeId,
	}

	customInfoType := &dlppb.CustomInfoType{
		InfoType: infoType,
		Type: &dlppb.CustomInfoType_StoredType{
			StoredType: storedType,
		},
	}

	// Specify how the content should be inspected.
	inspectConfig := &dlppb.InspectConfig{
		CustomInfoTypes: []*dlppb.CustomInfoType{
			customInfoType,
		},
		IncludeQuote: true,
	}

	// Construct the Inspect request to be sent by the client.
	req := &dlppb.InspectContentRequest{
		Parent:        fmt.Sprintf("projects/%s/locations/global", projectID),
		InspectConfig: inspectConfig,
		Item:          contentItem,
	}

	// Use the client to send the API 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

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.


import com.google.cloud.dlp.v2.DlpServiceClient;
import com.google.privacy.dlp.v2.ContentItem;
import com.google.privacy.dlp.v2.CustomInfoType;
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.privacy.dlp.v2.ProjectStoredInfoTypeName;
import com.google.privacy.dlp.v2.StoredType;
import java.io.IOException;

public class InspectWithStoredInfotype {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    // The Google Cloud project id to use as a parent resource.
    String projectId = "your-project-id";
    // The sample assumes that you have an existing stored infoType.
    // To create a stored InfoType refer:
    // https://cloud.google.com/dlp/docs/creating-stored-infotypes#create-storedinfotye 
    String storedInfoTypeId = "your-info-type-id";
    // The string to de-identify.
    String textToInspect =
        "My phone number is (223) 456-7890 and my email address is gary@example.com.";
    inspectWithStoredInfotype(projectId, storedInfoTypeId, textToInspect);
  }

  //  Inspects the given text using the specified stored infoType detector.
  public static void inspectWithStoredInfotype(
      String projectId, String storedInfoTypeId, String textToInspect) 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 content to be inspected.
      ContentItem contentItem = ContentItem.newBuilder().setValue(textToInspect).build();

      InfoType infoType = InfoType.newBuilder().setName("STORED_TYPE").build();

      // Reference to the existing StoredInfoType to inspect the data.
      StoredType storedType = StoredType.newBuilder()
              .setName(ProjectStoredInfoTypeName.of(projectId, storedInfoTypeId).toString())
              .build();

      CustomInfoType customInfoType =
          CustomInfoType.newBuilder().setInfoType(infoType).setStoredType(storedType).build();

      // Construct the configuration for the Inspect request.
      InspectConfig inspectConfig =
          InspectConfig.newBuilder()
              .addCustomInfoTypes(customInfoType)
              .setIncludeQuote(true)
              .build();

      // Construct the Inspect request to be sent by the client.
      InspectContentRequest inspectContentRequest =
          InspectContentRequest.newBuilder()
              .setParent(LocationName.of(projectId, "global").toString())
              .setInspectConfig(inspectConfig)
              .setItem(contentItem)
              .build();

      // Use the client to send the API request.
      InspectContentResponse response = dlp.inspectContent(inspectContentRequest);

      // 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("\tInfoType: " + f.getInfoType().getName());
        System.out.println("\tLikelihood: " + f.getLikelihood() + "\n");
      }
    }
  }
}

Node.js

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.

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

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

// The project ID to run the API call under.
// const projectId = 'your-project-id';

// The custom info-type id created and stored in the bucket.
// const infoTypeId = 'your-info-type-id';

// The string to inspect.
// const string = 'My phone number is (223) 456-7890 and my email address is gary@example.com.';

async function inspectWithStoredInfotype() {
  // Reference to the existing StoredInfoType to inspect the data.
  const customInfoType = {
    infoType: {
      name: 'GITHUB_LOGINS',
    },
    storedType: {
      name: infoTypeId,
    },
  };

  // Construct the configuration for the Inspect request.
  const inspectConfig = {
    customInfoTypes: [customInfoType],
    includeQuote: true,
  };

  // Construct the Inspect request to be sent by the client.
  const request = {
    parent: `projects/${projectId}/locations/global`,
    inspectConfig: inspectConfig,
    item: {
      value: string,
    },
  };
  // Run 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.');
  }
}
await inspectWithStoredInfotype();

PHP

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.

use Google\Cloud\Dlp\V2\Client\DlpServiceClient;
use Google\Cloud\Dlp\V2\ContentItem;
use Google\Cloud\Dlp\V2\CustomInfoType;
use Google\Cloud\Dlp\V2\InfoType;
use Google\Cloud\Dlp\V2\InspectConfig;
use Google\Cloud\Dlp\V2\InspectContentRequest;
use Google\Cloud\Dlp\V2\Likelihood;
use Google\Cloud\Dlp\V2\StoredType;

/**
 * Inspect with stored infoType.
 * Scan content using a large custom dictionary detector.
 *
 * @param string $projectId             The Google Cloud Project ID to run the API call under.
 * @param string $storedInfoTypeName    The name of the stored infotype whose This value must be in the format
 * projects/projectName/(locations/locationId)/storedInfoTypes/storedInfoTypeName.
 * @param string $textToInspect         The string to inspect.
 */
function inspect_with_stored_infotype(
    string $projectId,
    string $storedInfoTypeName,
    string $textToInspect
): void {
    // Instantiate a client.
    $dlp = new DlpServiceClient();

    $parent = "projects/$projectId/locations/global";

    // Specify the content to be inspected.
    $item = (new ContentItem())
        ->setValue($textToInspect);

    // Reference to the existing StoredInfoType to inspect the data.
    $customInfoType = (new CustomInfoType())
        ->setInfoType((new InfoType())
            ->setName('STORED_TYPE'))
        ->setStoredType((new StoredType())
            ->setName($storedInfoTypeName));

    // Construct the configuration for the Inspect request.
    $inspectConfig = (new InspectConfig())
        ->setCustomInfoTypes([$customInfoType])
        ->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) {
        printf('No findings.' . PHP_EOL);
    } else {
        printf('Findings:' . PHP_EOL);
        foreach ($findings as $finding) {
            printf('  Quote: %s' . PHP_EOL, $finding->getQuote());
            printf('  Info type: %s' . PHP_EOL, $finding->getInfoType()->getName());
            printf('  Likelihood: %s' . PHP_EOL, Likelihood::name($finding->getLikelihood()));
        }
    }
}

Python

Pour savoir comment installer et utiliser la bibliothèque cliente pour Sensitive Data Protection, consultez Bibliothèques clientes Sensitive Data Protection.

import google.cloud.dlp


def inspect_with_stored_infotype(
    project: str,
    stored_info_type_id: str,
    content_string: str,
) -> None:
    """Uses the Data Loss Prevention API to inspect/scan content using stored
    infoType.
    Args:
        project: The Google Cloud project id to use as a parent resource.
        content_string: The string to inspect.
        stored_info_type_id: The identifier of stored infoType used to inspect.
    """

    # Instantiate a client.
    dlp = google.cloud.dlp_v2.DlpServiceClient()

    # Convert stored infoType id into full resource id
    stored_type_name = f"projects/{project}/storedInfoTypes/{stored_info_type_id}"

    # Construct a custom info type dictionary using stored infoType.
    custom_info_types = [
        {
            "info_type": {"name": "STORED_TYPE"},
            "stored_type": {
                "name": stored_type_name,
            },
        }
    ]

    # Construct the inspection configuration dictionary.
    inspect_config = {
        "custom_info_types": custom_info_types,
        "include_quote": True,
    }

    # Construct the `item` to be inspected using stored infoType.
    item = {"value": content_string}

    # 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": item,
        }
    )

    # Print out the 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.")

REST

Lorsqu'il est envoyé à la méthode content.inspect, l'exemple suivant analyse le texte donné à l'aide du détecteur d'infoType stocké spécifié. Le paramètre infoType est obligatoire, car tous les infoTypes personnalisés doivent avoir un nom qui n'entre pas en conflit avec les infoTypes intégrés ou d'autres infoTypes personnalisés. Le paramètre storedType contient le chemin d'accès complet à la ressource de l'infoType stocké.

Entrée JSON

POST https://dlp.googleapis.com/v2/projects/PROJECT_ID/content:inspect

{
  "inspectConfig":{
    "customInfoTypes":[
      {
        "infoType":{
          "name":"GITHUB_LOGINS"
        },
        "storedType":{
          "name":"projects/PROJECT_ID/storedInfoTypes/github-logins"
        }
      }
    ]
  },
  "item":{
    "value":"The commit was made by githubuser."
  }
}

Résoudre les erreurs

Si vous obtenez une erreur lorsque vous essayez de créer un infoType stocké à partir d'une liste de termes stockée dans Cloud Storage, voici les causes possibles :

Vous avez atteint la limite maximale d'infoTypes stockés. Selon le problème, il existe plusieurs solutions de contournement :
- Si vous atteignez la limite maximale pour un seul fichier d'entrée dans Cloud Storage (200 Mo), essayez de le diviser en plusieurs fichiers. Vous pouvez utiliser plusieurs fichiers pour assembler un seul dictionnaire personnalisé, à condition que la taille combinée de tous les fichiers ne dépasse pas 1 Go.
- BigQuery n'a pas les mêmes limites que Cloud Storage. Envisagez de déplacer les termes dans une table BigQuery. La taille maximale d'une colonne de dictionnaire personnalisé dans BigQuery est de 1 Go, et le nombre maximal de lignes est de 5 000 000.
- Si votre fichier de liste de termes dépasse toutes les limites applicables aux listes de termes sources, vous devez le diviser en plusieurs fichiers et créer un dictionnaire pour chaque fichier. Ensuite, créez un job d'analyse distinct pour chaque dictionnaire.
Un ou plusieurs de vos termes ne contiennent pas au moins une lettre ou un chiffre. La protection des données sensibles ne peut pas rechercher des termes composés uniquement d'espaces ou de symboles. Un terme doit comporter au moins une lettre ou un chiffre. Vérifiez si votre liste inclut de tels termes. Le cas échéant, corrigez-les ou supprimez-les.
Votre liste de termes contient une expression avec trop de "composants". Dans ce contexte, un composant est une séquence continue ne contenant que des lettres, que des chiffres, ou que des caractères autres que des lettres et des chiffres, tels que des espaces ou des symboles. Vérifiez si votre liste inclut de tels termes. Le cas échéant, corrigez-les ou supprimez-les.
L'agent de service Sensitive Data Protection n'a pas accès aux données sources du dictionnaire ni au bucket Cloud Storage permettant de stocker les fichiers du dictionnaire. Pour résoudre ce problème, attribuez à l'agent de service Sensitive Data Protection le rôle d'administrateur de l'espace de stockage (roles/storage.admin) ou les rôles de propriétaire de données BigQuery (roles/bigquery.dataOwner) et d'utilisateur de job BigQuery (roles/bigquery.jobUser).

Présentation de l'API

La création d'un infoType stocké est requise si vous créez un détecteur de dictionnaire personnalisé volumineux.

Un infoType stocké est représenté dans Sensitive Data Protection par l'objet StoredInfoType. Il se compose des objets associés suivants :

StoredInfoTypeVersion inclut la date et l'heure de création, ainsi que les cinq derniers messages d'erreur survenus lors de la création de la version actuelle.
- StoredInfoTypeConfig contient la configuration de l'infoType stocké, y compris son nom et sa description. Pour un dictionnaire personnalisé de grande taille, type doit être un LargeCustomDictionaryConfig.
  - LargeCustomDictionaryConfig spécifie les deux éléments suivants :
    - L'emplacement dans Cloud Storage ou BigQuery où votre liste d'expressions est stockée
    - L'emplacement dans Cloud Storage qui sert à stocker les fichiers de dictionnaire générés
- StoredInfoTypeState contient l'état de la version la plus récente de l'infoType stocké, ainsi que toutes ses versions en attente. Les informations d'état indiquent si l'infoType stocké est en cours de recompilation, prêt à être utilisé ou non valide.

Caractéristiques des correspondances avec le dictionnaire

Vous trouverez ci-dessous des conseils sur la façon dont Sensitive Data Protection met en correspondance les mots et expressions du dictionnaire. Ces points s'appliquent aux dictionnaires personnalisés standards et volumineux :

Les mots du dictionnaire sont insensibles à la casse. Si votre dictionnaire inclut le nom Abby, il y aura correspondance avec les noms abby, ABBY, Abby, etc.
Tous les caractères (dans les dictionnaires ou dans le contenu à analyser) autres que les lettres, les chiffres et les autres caractères alphabétiques contenus dans le plan multilingue de base Unicode sont considérés comme des espaces lors de l'analyse des correspondances. Si votre dictionnaire recherche le nom Abby Abernathy, il y aura correspondance avec abby abernathy, Abby, Abernathy, Abby (ABERNATHY), etc.
Les caractères entourant une correspondance doivent être d'un type différent (lettres ou chiffres) des caractères adjacents au sein du mot. Si votre dictionnaire recherche le nom Abi, il y aura correspondance avec les trois premiers caractères de Abi904, mais pas de Abigail.
Les mots du dictionnaire contenant des caractères du plan multilingue supplémentaire de la norme Unicode peuvent générer des résultats inattendus. Il peut s'agir d'emoji, de symboles scientifiques et d'écritures historiques.

Les lettres, les chiffres et les autres caractères alphabétiques sont définis comme suit :

Lettres : caractères des catégories générales Lu, Ll, Lt, Lm ou Lo dans la spécification Unicode
Chiffres : caractères de la catégorie générale Nd dans la spécification Unicode
Autres caractères alphabétiques : caractères de la catégorie générale Nl dans la spécification Unicode ou avec la propriété contributive Other_Alphabetic telle que définie par la norme Unicode

Pour créer, modifier ou supprimer un infoType stocké, servez-vous des méthodes suivantes :

storedInfoTypes.create : crée un infoType stocké en fonction de la configuration StoredInfoTypeConfig spécifiée.
storedInfoTypes.patch : recrée l'infoType stocké avec un nouveau StoredInfoTypeConfig que vous spécifiez. Si aucune valeur n'est spécifiée, cette méthode crée une version de l'infoType stocké avec l'ID StoredInfoTypeConfig existant.
storedInfoTypes.get : récupère l'objet StoredInfoTypeConfig et toutes les versions en attente de l'infoType stocké spécifié.
storedInfoTypes.list : répertorie tous les infoTypes stockés actuels.
storedInfoTypes.delete : supprime l'infoType stocké spécifié.

Créer un détecteur de dictionnaire personnalisé de grande taille Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Quand choisir un dictionnaire personnalisé de grande taille plutôt qu'un dictionnaire personnalisé standard ?

Différences entre les dictionnaires personnalisés de grande taille et les autres infoTypes personnalisés

Créer un dictionnaire personnalisé de grande taille

Créer une liste de termes

Créer un infoType stocké

Console

C#

Go

Java

Node.js

PHP

Python

REST

Recompiler le dictionnaire

Console

C#

Go

Java

Node.js

PHP

Python

REST

Mettre à jour la liste de termes

Exemple

Changer de liste de termes sources

Exemple

Analyser du contenu à l'aide d'un détecteur de dictionnaire personnalisé de grande taille

Console

C#

Go

Java

Node.js

PHP

Python

REST

Résoudre les erreurs

Présentation de l'API

Caractéristiques des correspondances avec le dictionnaire

Créer un détecteur de dictionnaire personnalisé de grande taille