この拡張機能を使用すると、コンテンツや画像に含まれる機密データを難読化できます。たとえば、クレジット カード番号、名前、社会保障番号を秘匿化できます。
ここでは、この拡張機能を構成して使用する方法についてのリファレンスを提供します。この拡張機能の構成に関するリファレンスについては、構成リファレンスをご覧ください。
Google Cloud Data Loss Prevention(DLP)拡張機能を使用するには、DLP コンソールで DLP が有効にされている必要があります。
Cloud Data Loss Prevention(DLP)について
Google Data Loss Prevention(DLP)は、テキスト、画像、およびその他のデータを検査して機密データを識別し、管理するための API です。
詳しくは、DLP の概要をご覧ください。この拡張機能が公開する API のリファレンスについては、Cloud Data Loss Prevention(DLP)API をご覧ください。
アクション
deidentifyWithMask
text
に含まれる機密データを匿名化し、そのデータを mask
文字でマスクします。
機密データのマスキングによって、文字がアスタリスク(*)やハッシュ(#)などの記号で置き換えられます。処理対象とする機密データのタイプは、拡張機能の構成で設定できます。
リクエスト パラメータ
<Input><![CDATA[{
"text" : "text-to-deidentify",
"mask" : "masking-character"
}]]></Input>
パラメータ | 説明 | 型 | デフォルト | 必須 |
---|---|---|---|---|
text | 匿名化するテキスト。 | 文字列 | なし | ○ |
mask | 機密データをマスクするために使用する文字。 | 文字列 | なし | ○ |
レスポンス
匿名化されたテキスト。
deidentifyWithType
テキスト コンテンツ内の機密データを、一致する各値を infoType の名前で置き換えることによって匿名化します。infoType のリストについては、InfoType 検出器リファレンスをご覧ください。
次の例では、サービスによって電話番号が識別されると、その番号が infoType 自体の名前で置き換えられます。
入力テキスト:
John Smith, 123 Main St, Seattle, WA 98122, 206-555-0123.
処理後のテキスト:
John Smith, 123 Main St, Seattle, WA 98122, PHONE_NUMBER.
リクエスト パラメータ
<Input><![CDATA[{
"text" : "text-to-deidentify"
}]]></Input>
パラメータ | 説明 | 型 | デフォルト | 必須 |
---|---|---|---|---|
text | 匿名化するテキスト。 | 文字列 | なし | ○ |
レスポンス
匿名化されたテキスト。
redactImage
infoType カテゴリのいずれかに分類されるテキストを秘匿化します。秘匿化されたコンテンツが検出されると、不透明な矩形で難読化されます。
infoType のリストについては、InfoType 検出器リファレンスをご覧ください。
リクエスト パラメータ
<Input><![CDATA[{
"image_data" : "base64-encoded-image-to-analyze",
"image_type" : "type-of-image"
}]]></Input>
パラメータ | 説明 | 型 | デフォルト | 必須 |
---|---|---|---|---|
image_data | base64 でエンコードされた画像データ。 | 文字列 | なし | ○ |
image_type | 画像タイプの定数。有効な値は、IMAGE_JPEG、IMAGE_BMP、IMAGE_PNG、IMAGE_SVG です。 | 文字列 | なし | ○ |
レスポンス
テキストが秘匿化された画像。
構成リファレンス
この拡張機能を API プロキシで使用するために構成してデプロイする際は、以下に記載するプロパティを使用してください。Apigee Console で拡張機能を構成する手順については、拡張機能の追加と構成をご覧ください。
共通の拡張機能プロパティ
すべての拡張機能には次のプロパティがあります。
プロパティ | 説明 | デフォルト | 必須 |
---|---|---|---|
name |
この拡張機能に付ける名前。 | なし | ○ |
packageName |
Apigee Edge から提供された拡張機能パッケージの名前。 | なし | ○ |
version |
拡張機能を構成する拡張機能パッケージのバージョン番号。 | なし | ○ |
configuration |
追加する拡張機能に固有の構成値。この拡張機能パッケージのプロパティをご覧ください。 | なし | ○ |
この拡張機能パッケージのプロパティ
この拡張機能に固有の以下の構成プロパティに値を指定します。
プロパティ | 説明 | デフォルト | 必須 |
---|---|---|---|
projectId | Data Loss Prevention API が有効にされている GCP プロジェクトのプロジェクト ID。 | なし | ○ |
infoType | 機密データの情報タイプ。省略すると、サービスはすべての組み込みタイプを検出します。 | なし | × |
credentials | Apigee Edge コンソール内で入力する場合は、サービス アカウントのキーファイルの内容です。管理 API を使用して設定する場合は、サービス アカウントのキーファイルから生成された、base64 でエンコード済みの値です。 | なし | ○ |