Google Analytics Admin V1alpha Client - Class SearchChangeHistoryEventsRequest (0.24.0)

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

Request message for SearchChangeHistoryEvents RPC.

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

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ account string

Required. The account resource for which to return change history resources. Format: accounts/{account} Example: accounts/100
↳ property string

Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: properties/100
↳ resource_type array

Optional. If set, only return changes if they are for a resource that matches at least one of these types.
↳ action array

Optional. If set, only return changes that match one or more of these types of actions.
↳ actor_email array

Optional. If set, only return changes if they are made by a user in this list.
↳ earliest_change_time Google\Protobuf\Timestamp

Optional. If set, only return changes made after this time (inclusive).
↳ latest_change_time Google\Protobuf\Timestamp

Optional. If set, only return changes made before this time (inclusive).
↳ page_size int

Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
↳ page_token string

Optional. A page token, received from a previous SearchChangeHistoryEvents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchChangeHistoryEvents must match the call that provided the page token.

getAccount

Required. The account resource for which to return change history resources. Format: accounts/{account} Example: accounts/100

Returns
Type Description
string

setAccount

Required. The account resource for which to return change history resources. Format: accounts/{account} Example: accounts/100

Parameter
Name Description
var string
Returns
Type Description
$this

getProperty

Optional. Resource name for a child property. If set, only return changes made to this property or its child resources.

Format: properties/{propertyId} Example: properties/100

Returns
Type Description
string

setProperty

Optional. Resource name for a child property. If set, only return changes made to this property or its child resources.

Format: properties/{propertyId} Example: properties/100

Parameter
Name Description
var string
Returns
Type Description
$this

getResourceType

Optional. If set, only return changes if they are for a resource that matches at least one of these types.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setResourceType

Optional. If set, only return changes if they are for a resource that matches at least one of these types.

Parameter
Name Description
var int[]
Returns
Type Description
$this

getAction

Optional. If set, only return changes that match one or more of these types of actions.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAction

Optional. If set, only return changes that match one or more of these types of actions.

Parameter
Name Description
var int[]
Returns
Type Description
$this

getActorEmail

Optional. If set, only return changes if they are made by a user in this list.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setActorEmail

Optional. If set, only return changes if they are made by a user in this list.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getEarliestChangeTime

Optional. If set, only return changes made after this time (inclusive).

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEarliestChangeTime

clearEarliestChangeTime

setEarliestChangeTime

Optional. If set, only return changes made after this time (inclusive).

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLatestChangeTime

Optional. If set, only return changes made before this time (inclusive).

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLatestChangeTime

clearLatestChangeTime

setLatestChangeTime

Optional. If set, only return changes made before this time (inclusive).

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getPageSize

Optional. The maximum number of ChangeHistoryEvent items to return.

The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum).

Returns
Type Description
int

setPageSize

Optional. The maximum number of ChangeHistoryEvent items to return.

The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum).

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A page token, received from a previous SearchChangeHistoryEvents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchChangeHistoryEvents must match the call that provided the page token.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous SearchChangeHistoryEvents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchChangeHistoryEvents must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this