Method: floodlightGroups.floodlightActivities.list

  • This document provides a reference for listing Floodlight activities within a Floodlight group using an HTTP GET request.

  • The request requires a floodlightGroupId path parameter and a partnerId query parameter.

  • Optional query parameters include pageSize, pageToken, and orderBy for controlling the results.

  • The request body should be empty, and the response body will contain a list of FloodlightActivity objects and a nextPageToken if there are more results.

  • Authorization requires the https://www.googleapis.com/auth/display-video OAuth scope.

Lists Floodlight activities in a Floodlight group.

HTTP request

GET https://displayvideo.googleapis.com/v4/floodlightGroups/{floodlightGroupId}/floodlightActivities

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
floodlightGroupId

string (int64 format)

Required. The ID of the parent Floodlight group to which the requested Floodlight activities belong.

Query parameters

Parameters
partnerId

string (int64 format)

Required. The ID of the partner through which the Floodlight activities are being accessed.
pageSize

integer

Optional. Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.
pageToken

string

Optional. A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to floodlightActivities.list method. If not specified, the first page of results will be returned.
orderBy

string

Optional. Field by which to sort the list. Acceptable values are:

  • displayName (default)
  • floodlightActivityId

The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "floodlightActivities": [
    {
      object (FloodlightActivity)
    }
  ],
  "nextPageToken": string
}
Fields
floodlightActivities[]

object (FloodlightActivity)

The list of Floodlight activities.

This list will be absent if empty.
nextPageToken

string

A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to floodlightActivities.list method to retrieve the next page of results.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.