Method: floodlightActivities.list

  • This method retrieves a list of floodlight activities, with optional filtering and support for paging.

  • The HTTP request uses a GET method to a specific URL containing the user's profile ID.

  • Path parameters include the mandatory profileId.

  • Query parameters allow filtering by various criteria such as IDs, advertiser ID, floodlight configuration ID, tag string, and more, along with options for paging and sorting.

  • The request body for this method must be empty.

  • The response body contains a JSON representation including the list of floodlight activities, a kind identifier, and a pagination token.

  • The method requires authorization using the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

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

HTTP request

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

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 activities with the specified IDs. Must specify either

ids

,

advertiserId

, or

floodlightConfigurationId

for a non-empty result.
floodlightActivityGroupIds[]

string (int64 format)

Select only floodlight activities with the specified floodlight activity group IDs.
floodlightConfigurationId

string (int64 format)

Select only floodlight activities for the specified floodlight configuration ID. Must specify either

ids

,

advertiserId

, or

floodlightConfigurationId

for a non-empty result.
advertiserId

string (int64 format)

Select only floodlight activities for the specified advertiser ID. Must specify either

ids

,

advertiserId

, or

floodlightConfigurationId

for a non-empty result.
tagString

string

Select only floodlight activities with the specified tag string.
floodlightActivityGroupType

enum (FloodlightActivityGroupType)

Select only floodlight activities with the specified floodlight activity group type.
floodlightActivityGroupTagString

string

Select only floodlight activities with the specified floodlight activity group tag string.
floodlightActivityGroupName

string

Select only floodlight activities with the specified floodlight activity group name.
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,

"floodlightactivity*2015"

will return objects with names like

"floodlightactivity June 2015"

,

"floodlightactivity April 2015"

, or simply

"floodlightactivity 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

"floodlightactivity"

will match objects with name

"my floodlightactivity activity"

,

"floodlightactivity 2015"

, or simply

"floodlightactivity"

.
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 floodlightActivities.list Response

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

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

string

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

"dfareporting#floodlightActivitiesListResponse"

.
nextPageToken

string

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

object (FloodlightActivity)

Floodlight activity collection.

Authorization scopes

Requires the following OAuth scope:

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