Reference documentation and code samples for the Google Analytics Admin V1alpha Client class DataRedactionSettings.
Settings for client-side data redaction. Singleton resource under a Web
Stream.
Generated from protobuf message google.analytics.admin.v1alpha.DataRedactionSettings
Namespace
Google \ Analytics \ Admin \ V1alpha
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"
↳ email_redaction_enabled
bool
If enabled, any event parameter or user property values that look like an email will be redacted.
↳ query_parameter_redaction_enabled
bool
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 query_parameter_keys will be redacted.
↳ query_parameter_keys
array
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.
getName
Output only. Name of this Data Redaction Settings resource.
If enabled, any event parameter or user property values that look like an
email will be redacted.
Returns
Type
Description
bool
setEmailRedactionEnabled
If enabled, any event parameter or user property values that look like an
email will be redacted.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getQueryParameterRedactionEnabled
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 query_parameter_keys will be redacted.
Returns
Type
Description
bool
setQueryParameterRedactionEnabled
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 query_parameter_keys will be redacted.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getQueryParameterKeys
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Analytics Admin V1alpha Client - Class DataRedactionSettings (0.29.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.29.1 (latest)](/php/docs/reference/analytics-admin/latest/V1alpha.DataRedactionSettings)\n- [0.29.0](/php/docs/reference/analytics-admin/0.29.0/V1alpha.DataRedactionSettings)\n- [0.28.1](/php/docs/reference/analytics-admin/0.28.1/V1alpha.DataRedactionSettings)\n- [0.27.0](/php/docs/reference/analytics-admin/0.27.0/V1alpha.DataRedactionSettings)\n- [0.26.0](/php/docs/reference/analytics-admin/0.26.0/V1alpha.DataRedactionSettings)\n- [0.25.2](/php/docs/reference/analytics-admin/0.25.2/V1alpha.DataRedactionSettings)\n- [0.24.2](/php/docs/reference/analytics-admin/0.24.2/V1alpha.DataRedactionSettings)\n- [0.23.0](/php/docs/reference/analytics-admin/0.23.0/V1alpha.DataRedactionSettings)\n- [0.22.5](/php/docs/reference/analytics-admin/0.22.5/V1alpha.DataRedactionSettings)\n- [0.20.0](/php/docs/reference/analytics-admin/0.20.0/V1alpha.DataRedactionSettings)\n- [0.19.0](/php/docs/reference/analytics-admin/0.19.0/V1alpha.DataRedactionSettings)\n- [0.18.1](/php/docs/reference/analytics-admin/0.18.1/V1alpha.DataRedactionSettings)\n- [0.17.0](/php/docs/reference/analytics-admin/0.17.0/V1alpha.DataRedactionSettings)\n- [0.16.0](/php/docs/reference/analytics-admin/0.16.0/V1alpha.DataRedactionSettings)\n- [0.15.1](/php/docs/reference/analytics-admin/0.15.1/V1alpha.DataRedactionSettings)\n- [0.14.0](/php/docs/reference/analytics-admin/0.14.0/V1alpha.DataRedactionSettings)\n- [0.13.0](/php/docs/reference/analytics-admin/0.13.0/V1alpha.DataRedactionSettings)\n- [0.12.0](/php/docs/reference/analytics-admin/0.12.0/V1alpha.DataRedactionSettings)\n- [0.11.1](/php/docs/reference/analytics-admin/0.11.1/V1alpha.DataRedactionSettings)\n- [0.10.0](/php/docs/reference/analytics-admin/0.10.0/V1alpha.DataRedactionSettings)\n- [0.9.0](/php/docs/reference/analytics-admin/0.9.0/V1alpha.DataRedactionSettings)\n- [0.8.2](/php/docs/reference/analytics-admin/0.8.2/V1alpha.DataRedactionSettings) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Admin V1alpha Client class DataRedactionSettings.\n\nSettings for client-side data redaction. Singleton resource under a Web\nStream.\n\nGenerated from protobuf message `google.analytics.admin.v1alpha.DataRedactionSettings`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Admin \\\\ V1alpha\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. Name of this Data Redaction Settings resource.\n\nFormat:\nproperties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings\nExample: \"properties/1000/dataStreams/2000/dataRedactionSettings\"\n\n### setName\n\nOutput only. Name of this Data Redaction Settings resource.\n\nFormat:\nproperties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings\nExample: \"properties/1000/dataStreams/2000/dataRedactionSettings\"\n\n### getEmailRedactionEnabled\n\nIf enabled, any event parameter or user property values that look like an\nemail will be redacted.\n\n### setEmailRedactionEnabled\n\nIf enabled, any event parameter or user property values that look like an\nemail will be redacted.\n\n### getQueryParameterRedactionEnabled\n\nQuery Parameter redaction removes the key and value portions of a\nquery parameter if it is in the configured set of query parameters.\n\nIf enabled, URL query replacement logic will be run for the Stream. Any\nquery parameters defined in query_parameter_keys will be redacted.\n\n### setQueryParameterRedactionEnabled\n\nQuery Parameter redaction removes the key and value portions of a\nquery parameter if it is in the configured set of query parameters.\n\nIf enabled, URL query replacement logic will be run for the Stream. Any\nquery parameters defined in query_parameter_keys will be redacted.\n\n### getQueryParameterKeys\n\nThe query parameter keys to apply redaction logic to if present in the URL.\n\nQuery parameter matching is case-insensitive.\nMust contain at least one element if query_parameter_replacement_enabled\nis true. Keys cannot contain commas.\n\n### setQueryParameterKeys\n\nThe query parameter keys to apply redaction logic to if present in the URL.\n\nQuery parameter matching is case-insensitive.\nMust contain at least one element if query_parameter_replacement_enabled\nis true. Keys cannot contain commas."]]
