Reference documentation and code samples for the Google Analytics Admin V1alpha Client class UpdateKeyEventRequest.
Request message for UpdateKeyEvent RPC
Generated from protobuf message google.analytics.admin.v1alpha.UpdateKeyEventRequest
Namespace
Google \ Analytics \ Admin \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ key_event |
Google\Analytics\Admin\V1alpha\KeyEvent
Required. The Key Event to update. The |
↳ update_mask |
Google\Protobuf\FieldMask
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
getKeyEvent
Required. The Key Event to update.
The name field is used to identify the settings to be updated.
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Admin\V1alpha\KeyEvent|null |
|
hasKeyEvent
clearKeyEvent
setKeyEvent
Required. The Key Event to update.
The name field is used to identify the settings to be updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Analytics\Admin\V1alpha\KeyEvent
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateMask
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null |
|
hasUpdateMask
clearUpdateMask
setUpdateMask
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
keyEvent |
Google\Analytics\Admin\V1alpha\KeyEvent
Required. The Key Event to update.
The |
updateMask |
Google\Protobuf\FieldMask
Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
| Returns | |
|---|---|
| Type | Description |
Google\Analytics\Admin\V1alpha\UpdateKeyEventRequest |
|