Reference documentation and code samples for the Google Apps Chat V1 Client class ListSpaceEventsRequest.
Request message for listing space events.
Generated from protobuf message google.chat.v1.ListSpaceEventsRequest
Namespace
Google \ Apps \ Chat \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. Resource name of the Google Chat space where the events occurred. Format: spaces/{space}.
↳ page_size
int
Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an INVALID_ARGUMENT error.
↳ page_token
string
Optional. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
↳ filter
string
Required. A query filter. You must specify at least one event type (event_type) using the has : operator. To filter by multiple event types, use the OR operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (google.workspace.chat.reaction.v1.created), the server also returns batch new reactions events (google.workspace.chat.reaction.v1.batchCreated). For a list of supported event types, see the SpaceEvents reference documentation. Optionally, you can also filter by start time (start_time) and end time (end_time): * * start_time: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days. * * end_time: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals = operator and format in RFC-3339. To filter by both start_time and end_time, use the AND operator. For example, the following queries are valid: start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00"start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created") The following queries are invalid: start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00"event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created" Invalid queries are rejected by the server with an INVALID_ARGUMENT error.
getParent
Required. Resource name of the Google Chat
space
where the events occurred.
Format: spaces/{space}.
Returns
Type
Description
string
setParent
Required. Resource name of the Google Chat
space
where the events occurred.
Format: spaces/{space}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The maximum number of space events returned. The service might
return fewer than this value.
Negative values return an INVALID_ARGUMENT error.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of space events returned. The service might
return fewer than this value.
Negative values return an INVALID_ARGUMENT error.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. A page token, received from a previous list space events call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to list space events must
match the call that provided the page token. Passing different values to
the other parameters might lead to unexpected results.
Returns
Type
Description
string
setPageToken
Optional. A page token, received from a previous list space events call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to list space events must
match the call that provided the page token. Passing different values to
the other parameters might lead to unexpected results.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Required. A query filter.
You must specify at least one event type (event_type)
using the has : operator. To filter by multiple event types, use the OR
operator. Omit batch event types in your filter. The request automatically
returns any related batch events. For example, if you filter by new
reactions
(google.workspace.chat.reaction.v1.created), the server also returns
batch new reactions events
(google.workspace.chat.reaction.v1.batchCreated). For a list of supported
event types, see the SpaceEvents reference
documentation.
Optionally, you can also filter by start time (start_time) and
end time (end_time):
start_time: Exclusive timestamp from which to start listing space
events.
You can list events that occurred up to 28 days ago. If unspecified, lists
space events from the past 28 days.
end_time: Inclusive timestamp until which space events are listed.
If unspecified, lists events up to the time of the request.
To specify a start or end time, use the equals = operator and format in
RFC-3339. To filter by both
start_time and end_time, use the AND operator.
For example, the following queries are valid:
php
start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"php
start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")
The following queries are invalid:
php
start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"php
event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"
Invalid queries are rejected by the server with an INVALID_ARGUMENT
error.
Returns
Type
Description
string
setFilter
Required. A query filter.
You must specify at least one event type (event_type)
using the has : operator. To filter by multiple event types, use the OR
operator. Omit batch event types in your filter. The request automatically
returns any related batch events. For example, if you filter by new
reactions
(google.workspace.chat.reaction.v1.created), the server also returns
batch new reactions events
(google.workspace.chat.reaction.v1.batchCreated). For a list of supported
event types, see the SpaceEvents reference
documentation.
Optionally, you can also filter by start time (start_time) and
end time (end_time):
start_time: Exclusive timestamp from which to start listing space
events.
You can list events that occurred up to 28 days ago. If unspecified, lists
space events from the past 28 days.
end_time: Inclusive timestamp until which space events are listed.
If unspecified, lists events up to the time of the request.
To specify a start or end time, use the equals = operator and format in
RFC-3339. To filter by both
start_time and end_time, use the AND operator.
For example, the following queries are valid:
php
start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"php
start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")
The following queries are invalid:
php
start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"php
event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"
Invalid queries are rejected by the server with an INVALID_ARGUMENT
error.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameters
Name
Description
parent
string
Required. Resource name of the Google Chat
space
where the events occurred.
Format: spaces/{space}. Please see
ChatServiceClient::spaceName() for help formatting this field.
filter
string
Required. A query filter.
You must specify at least one event type (event_type)
using the has : operator. To filter by multiple event types, use the OR
operator. Omit batch event types in your filter. The request automatically
returns any related batch events. For example, if you filter by new
reactions
(google.workspace.chat.reaction.v1.created), the server also returns
batch new reactions events
(google.workspace.chat.reaction.v1.batchCreated). For a list of supported
event types, see the SpaceEvents reference
documentation.
Optionally, you can also filter by start time (start_time) and
end time (end_time):
start_time: Exclusive timestamp from which to start listing space
events.
You can list events that occurred up to 28 days ago. If unspecified, lists
space events from the past 28 days.
end_time: Inclusive timestamp until which space events are listed.
If unspecified, lists events up to the time of the request.
To specify a start or end time, use the equals = operator and format in
RFC-3339. To filter by both
start_time and end_time, use the AND operator.
For example, the following queries are valid:
start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"
start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")
The following queries are invalid:
start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"
event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"
Invalid queries are rejected by the server with an INVALID_ARGUMENT
error.
[[["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 Apps Chat V1 Client - Class ListSpaceEventsRequest (0.12.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.12.0 (latest)](/php/docs/reference/apps-chat/latest/Chat.V1.ListSpaceEventsRequest)\n- [0.11.2](/php/docs/reference/apps-chat/0.11.2/Chat.V1.ListSpaceEventsRequest)\n- [0.10.0](/php/docs/reference/apps-chat/0.10.0/Chat.V1.ListSpaceEventsRequest)\n- [0.9.0](/php/docs/reference/apps-chat/0.9.0/Chat.V1.ListSpaceEventsRequest)\n- [0.8.1](/php/docs/reference/apps-chat/0.8.1/Chat.V1.ListSpaceEventsRequest)\n- [0.7.2](/php/docs/reference/apps-chat/0.7.2/Chat.V1.ListSpaceEventsRequest)\n- [0.6.1](/php/docs/reference/apps-chat/0.6.1/Chat.V1.ListSpaceEventsRequest)\n- [0.5.0](/php/docs/reference/apps-chat/0.5.0/Chat.V1.ListSpaceEventsRequest)\n- [0.4.0](/php/docs/reference/apps-chat/0.4.0/Chat.V1.ListSpaceEventsRequest)\n- [0.3.0](/php/docs/reference/apps-chat/0.3.0/Chat.V1.ListSpaceEventsRequest)\n- [0.2.0](/php/docs/reference/apps-chat/0.2.0/Chat.V1.ListSpaceEventsRequest)\n- [0.1.4](/php/docs/reference/apps-chat/0.1.4/Chat.V1.ListSpaceEventsRequest) \nReference documentation and code samples for the Google Apps Chat V1 Client class ListSpaceEventsRequest.\n\nRequest message for listing space events.\n\nGenerated from protobuf message `google.chat.v1.ListSpaceEventsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Apps \\\\ Chat \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Resource name of the [Google Chat\nspace](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces)\nwhere the events occurred.\n\nFormat: `spaces/{space}`.\n\n### setParent\n\nRequired. Resource name of the [Google Chat\nspace](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces)\nwhere the events occurred.\n\nFormat: `spaces/{space}`.\n\n### getPageSize\n\nOptional. The maximum number of space events returned. The service might\nreturn fewer than this value.\n\nNegative values return an `INVALID_ARGUMENT` error.\n\n### setPageSize\n\nOptional. The maximum number of space events returned. The service might\nreturn fewer than this value.\n\nNegative values return an `INVALID_ARGUMENT` error.\n\n### getPageToken\n\nOptional. A page token, received from a previous list space events call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to list space events must\nmatch the call that provided the page token. Passing different values to\nthe other parameters might lead to unexpected results.\n\n### setPageToken\n\nOptional. A page token, received from a previous list space events call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to list space events must\nmatch the call that provided the page token. Passing different values to\nthe other parameters might lead to unexpected results.\n\n### getFilter\n\nRequired. A query filter.\n\nYou must specify at least one event type (`event_type`)\nusing the has `:` operator. To filter by multiple event types, use the `OR`\noperator. Omit batch event types in your filter. The request automatically\nreturns any related batch events. For example, if you filter by new\nreactions\n(`google.workspace.chat.reaction.v1.created`), the server also returns\nbatch new reactions events\n(`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported\nevent types, see the [`SpaceEvents` reference\ndocumentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type).\nOptionally, you can also filter by start time (`start_time`) and\nend time (`end_time`):\n\n- `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days.\n- `end_time`: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals `=` operator and format in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: `php\n start_time=\"2023-08-23T19:20:33+00:00\" AND\n end_time=\"2023-08-23T19:21:54+00:00\"` `php\n start_time=\"2023-08-23T19:20:33+00:00\" AND\n (event_types:\"google.workspace.chat.space.v1.updated\" OR\n event_types:\"google.workspace.chat.message.v1.created\")` The following queries are invalid: `php\n start_time=\"2023-08-23T19:20:33+00:00\" OR\n end_time=\"2023-08-23T19:21:54+00:00\"` `php\n event_types:\"google.workspace.chat.space.v1.updated\" AND\n event_types:\"google.workspace.chat.message.v1.created\"` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.\n\n### setFilter\n\nRequired. A query filter.\n\nYou must specify at least one event type (`event_type`)\nusing the has `:` operator. To filter by multiple event types, use the `OR`\noperator. Omit batch event types in your filter. The request automatically\nreturns any related batch events. For example, if you filter by new\nreactions\n(`google.workspace.chat.reaction.v1.created`), the server also returns\nbatch new reactions events\n(`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported\nevent types, see the [`SpaceEvents` reference\ndocumentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type).\nOptionally, you can also filter by start time (`start_time`) and\nend time (`end_time`):\n\n- `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days.\n- `end_time`: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals `=` operator and format in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: `php\n start_time=\"2023-08-23T19:20:33+00:00\" AND\n end_time=\"2023-08-23T19:21:54+00:00\"` `php\n start_time=\"2023-08-23T19:20:33+00:00\" AND\n (event_types:\"google.workspace.chat.space.v1.updated\" OR\n event_types:\"google.workspace.chat.message.v1.created\")` The following queries are invalid: `php\n start_time=\"2023-08-23T19:20:33+00:00\" OR\n end_time=\"2023-08-23T19:21:54+00:00\"` `php\n event_types:\"google.workspace.chat.space.v1.updated\" AND\n event_types:\"google.workspace.chat.message.v1.created\"` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.\n\n### static::build"]]
