Method: floodlightActivityGroups.list

  • This method retrieves a list of floodlight activity groups, which can be filtered and supports paging.

  • The HTTP request uses a GET method with a URL that includes a profileId path parameter.

  • Optional query parameters are available to filter the results by IDs, type, advertiser ID, floodlight configuration ID, control the number of results, and search by name or ID.

  • The request body must be empty, and the response body contains a list of floodlight activity group objects.

  • Authorization requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/floodlightActivityGroups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Query parameters

Parameters
ids[]

string (int64 format)

Select only floodlight activity groups with the specified IDs. Must specify either

advertiserId

or

floodlightConfigurationId

for a non-empty result.
type

enum (FloodlightActivityGroupType)

Select only floodlight activity groups with the specified floodlight activity group type.
advertiserId

string (int64 format)

Select only floodlight activity groups with the specified advertiser ID. Must specify either

advertiserId

or

floodlightConfigurationId

for a non-empty result.
floodlightConfigurationId

string (int64 format)

Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either

advertiserId

, or

floodlightConfigurationId

for a non-empty result.
maxResults

integer

Maximum number of results to return.
pageToken

string

Value of the

nextPageToken

from the previous result page.
searchString

string

Allows searching for objects by name or ID. Wildcards (

*

) are allowed. For example,

"floodlightactivitygroup*2015"

will return objects with names like

"floodlightactivitygroup June 2015"

,

"floodlightactivitygroup April 2015"

, or simply

"floodlightactivitygroup 2015"

. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of

"floodlightactivitygroup"

will match objects with name

"my floodlightactivitygroup activity"

,

"floodlightactivitygroup 2015"

, or simply

"floodlightactivitygroup"

.
sortField

enum (SortField)

Field by which to sort the list.
sortOrder

enum (SortOrder)

Order of sorted results.

Request body

The request body must be empty.

Response body

Floodlight Activity Group floodlightActivityGroups.list Response

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

JSON representation 
{
  "kind": string,
  "nextPageToken": string,
  "floodlightActivityGroups": [
    {
      object (FloodlightActivityGroup)
    }
  ]
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#floodlightActivityGroupsListResponse"

.
nextPageToken

string

Pagination token to be used for the next list operation.
floodlightActivityGroups[]

object (FloodlightActivityGroup)

Floodlight activity group collection.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking