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 \ V1alphaMethods
__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.
Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. Name of this Data Redaction Settings resource.
Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEmailRedactionEnabled
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setQueryParameterKeys
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|