Method: projects.locations.channels.events.list

Stay organized with collections Save and categorize content based on your preferences.

Returns a list of all events in the specified channel.

HTTP request

GET https://livestream.googleapis.com/v1/{parent=projects/*/locations/*/channels/*}/events

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

Query parameters

Parameters
pageSize

integer

The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's nextPageToken to determine if there are more items left to be queried.

pageToken

string

The nextPageToken value returned from a previous List request, if any.

filter

string

The filter to apply to list results.

orderBy

string

Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for "LivestreamService.ListEvents".

JSON representation
{
  "events": [
    {
      object (Event)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
events[]

object (Event)

A list of events.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

unreachable[]

string

Locations that could not be reached.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • livestream.events.list

For more information, see the IAM documentation.