GOgoogle
floodlightActivities

GET /userprofiles/{userprofilesId}/floodlightActivities

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

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

userprofilesIdstring required

Query parameters

advertiserIdstring int64

Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.

floodlightActivityGroupIdsstring[]

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

floodlightActivityGroupNamestring

Select only floodlight activities with the specified floodlight activity group name.

floodlightActivityGroupTagStringstring

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

floodlightActivityGroupType'COUNTER' | 'SALE'

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

floodlightConfigurationIdstring int64

Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.

idsstring[]

Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.

maxResultsinteger

Maximum number of results to return.

pageTokenstring

Value of the nextPageToken from the previous result page.

searchStringstring

Allows searching for objects by name or ID. Wildcards () are allowed. For example, "floodlightactivity2015" 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'ID' | 'NAME'

Field by which to sort the list.

sortOrder'ASCENDING' | 'DESCENDING'

Order of sorted results.

tagStringstring

Select only floodlight activities with the specified tag string.

Response

Successful response

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".

nextPageTokenstring

Pagination token to be used for the next list operation.

Changes

No recorded changes to this operation across all 5 revisions of this API.