Method: floodlightConfigurations.list

  • This document details how to retrieve a list of floodlight configurations using a GET request to the specified URL.

  • The request requires a profileId as a path parameter.

  • Floodlight configurations can be filtered using the ids[] query parameter.

  • The response body contains a JSON object with a kind and a list of floodlightConfigurations.

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

Retrieves a list of floodlight configurations, possibly filtered.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{profileId}/floodlightConfigurations

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)

Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.

Request body

The request body must be empty.

Response body

Floodlight Configuration floodlightConfigurations.list Response

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

JSON representation 
{
  "kind": string,
  "floodlightConfigurations": [
    {
      object (FloodlightConfiguration)
    }
  ]
}
Fields
kind

string

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

"dfareporting#floodlightConfigurationsListResponse"

.
floodlightConfigurations[]

object (FloodlightConfiguration)

Floodlight configuration collection.

Authorization scopes

Requires the following OAuth scope:

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