DataRedactionSettings
Settings for client-side data redaction. Singleton resource under a Web Stream.
JSON representation |
{
"name": string,
"emailRedactionEnabled": boolean,
"queryParameterRedactionEnabled": boolean,
"queryParameterKeys": [
string
]
} |
Fields |
name |
string
Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{dataStream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"
|
emailRedactionEnabled |
boolean
If enabled, any event parameter or user property values that look like an email will be redacted.
|
queryParameterRedactionEnabled |
boolean
Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters. If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in queryParameterKeys will be redacted.
|
queryParameterKeys[] |
string
The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive. Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-14 UTC.
[null,null,["Last updated 2025-01-14 UTC."],[[["Data Redaction Settings allow you to control client-side redaction for a specific Web Stream, including email and query parameter redaction."],["When enabled, email redaction automatically obscures any event parameter or user property value resembling an email address."],["Query parameter redaction, when activated, removes specified query parameters and their values from URLs, requiring at least one query parameter key to be defined if enabled."],["The resource is identified by a unique name in the format: `properties/{property_id}/dataStreams/{dataStream}/dataRedactionSettings`."]]],["Data redaction settings for a web stream can be configured. Email redaction is enabled or disabled via `emailRedactionEnabled`. Query parameter redaction is controlled with `queryParameterRedactionEnabled`, which, when active, redacts specified keys and their values from URLs. The `queryParameterKeys` array lists the specific query parameter keys targeted for redaction; at least one key is required when query parameter redaction is enabled. The `name` field displays the resource name and path.\n"]]