Google Analytics Admin V1alpha Client - Class UpdateAudienceRequest (0.23.0)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class UpdateAudienceRequest.

Request message for UpdateAudience RPC.

Generated from protobuf message google.analytics.admin.v1alpha.UpdateAudienceRequest

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ audience Google\Analytics\Admin\V1alpha\Audience

Required. The audience to update. The audience's name field is used to identify the audience to be updated.

↳ 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.

getAudience

Required. The audience to update.

The audience's name field is used to identify the audience to be updated.

Returns
Type Description
Google\Analytics\Admin\V1alpha\Audience|null

hasAudience

clearAudience

setAudience

Required. The audience to update.

The audience's name field is used to identify the audience to be updated.

Parameter
Name Description
var Google\Analytics\Admin\V1alpha\Audience
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
audience Google\Analytics\Admin\V1alpha\Audience

Required. The audience to update. The audience's name field is used to identify the audience to be updated.

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\UpdateAudienceRequest