v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13217260568.5 KB
floodlightActivities

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

get/userprofiles/{+profileId}/floodlightActivities

Path parameters

profileIdstring required

User profile ID associated with this request.

Query parameters

advertiserIdstring

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

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