list method
Lists all profile filter links for a profile.
Request parameters:
accountId
- Account ID to retrieve profile filter links for.
Value must have pattern \d+
.
webPropertyId
- Web property Id for profile filter links for. Can either
be a specific web property ID or '~all', which refers to all the web
properties that user has access to.
profileId
- Profile ID to retrieve filter links for. Can either be a
specific profile ID or '~all', which refers to all the profiles that user
has access to.
maxResults
- The maximum number of profile filter links to include in
this response.
startIndex
- An index of the first entity to retrieve. Use this
parameter as a pagination mechanism along with the max-results parameter.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ProfileFilterLinks.
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<ProfileFilterLinks> list(
core.String accountId,
core.String webPropertyId,
core.String profileId, {
core.int? maxResults,
core.int? startIndex,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (maxResults != null) 'max-results': ['${maxResults}'],
if (startIndex != null) 'start-index': ['${startIndex}'],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'management/accounts/' +
commons.escapeVariable('$accountId') +
'/webproperties/' +
commons.escapeVariable('$webPropertyId') +
'/profiles/' +
commons.escapeVariable('$profileId') +
'/profileFilterLinks';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ProfileFilterLinks.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}