get method

Future<Profile> get(
  1. String accountId,
  2. String webPropertyId,
  3. String profileId, {
  4. String? $fields,
})

Gets a view (profile) to which the user has access.

Request parameters:

accountId - Account ID to retrieve the view (profile) for. Value must have pattern \[0-9\]+.

webPropertyId - Web property ID to retrieve the view (profile) for. Value must have pattern UA-\[0-9\]+-\[0-9\]+.

profileId - View (Profile) ID to retrieve the view (profile) for. Value must have pattern \[0-9\]+.

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

Completes with a Profile.

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<Profile> get(
  core.String accountId,
  core.String webPropertyId,
  core.String profileId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'management/accounts/' +
      commons.escapeVariable('$accountId') +
      '/webproperties/' +
      commons.escapeVariable('$webPropertyId') +
      '/profiles/' +
      commons.escapeVariable('$profileId');

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