list method

Future<FloodlightActivitiesListResponse> list(String profileId, { String? advertiserId, List<String>? floodlightActivityGroupIds, String? floodlightActivityGroupName, String? floodlightActivityGroupTagString, String? floodlightActivityGroupType, String? floodlightConfigurationId, List<String>? ids, int? maxResults, String? pageToken, String? searchString, String? sortField, String? sortOrder, String? tagString, String? $fields, })

Retrieves a list of floodlight activities, possibly filtered.

This method supports paging.

Request parameters:

profileId - User profile ID associated with this request. Value must have pattern ^\[^/\]+$.

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

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

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

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

floodlightActivityGroupType - Select only floodlight activities with the specified floodlight activity group type. Possible string values are:

• "COUNTER"
• "SALE"

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

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

maxResults - Maximum number of results to return.

pageToken - Value of the nextPageToken from the previous result page.

searchString - 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 - Field by which to sort the list. Possible string values are:

• "ID"
• "NAME"

sortOrder - Order of sorted results. Possible string values are:

• "ASCENDING" : Ascending order.
• "DESCENDING" : Descending order.

tagString - Select only floodlight activities with the specified tag string.

$fields - Selector specifying which fields to include in a partial response.

Completes with a FloodlightActivitiesListResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<FloodlightActivitiesListResponse> list(
  core.String profileId, {
  core.String? advertiserId,
  core.List<core.String>? floodlightActivityGroupIds,
  core.String? floodlightActivityGroupName,
  core.String? floodlightActivityGroupTagString,
  core.String? floodlightActivityGroupType,
  core.String? floodlightConfigurationId,
  core.List<core.String>? ids,
  core.int? maxResults,
  core.String? pageToken,
  core.String? searchString,
  core.String? sortField,
  core.String? sortOrder,
  core.String? tagString,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (advertiserId != null) 'advertiserId': [advertiserId],
    if (floodlightActivityGroupIds != null)
      'floodlightActivityGroupIds': floodlightActivityGroupIds,
    if (floodlightActivityGroupName != null)
      'floodlightActivityGroupName': [floodlightActivityGroupName],
    if (floodlightActivityGroupTagString != null)
      'floodlightActivityGroupTagString': [floodlightActivityGroupTagString],
    if (floodlightActivityGroupType != null)
      'floodlightActivityGroupType': [floodlightActivityGroupType],
    if (floodlightConfigurationId != null)
      'floodlightConfigurationId': [floodlightConfigurationId],
    if (ids != null) 'ids': ids,
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (searchString != null) 'searchString': [searchString],
    if (sortField != null) 'sortField': [sortField],
    if (sortOrder != null) 'sortOrder': [sortOrder],
    if (tagString != null) 'tagString': [tagString],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'userprofiles/' +
      core.Uri.encodeFull('$profileId') +
      '/floodlightActivities';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return FloodlightActivitiesListResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}