get method

Future<Experiment> get(String accountId, String webPropertyId, String profileId, String experimentId, { String? $fields, })

Returns an experiment to which the user has access.

Request parameters:

accountId - Account ID to retrieve the experiment for.

webPropertyId - Web property ID to retrieve the experiment for.

profileId - View (Profile) ID to retrieve the experiment for.

experimentId - Experiment ID to retrieve the experiment for.

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

Completes with a Experiment.

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<Experiment> get(
  core.String accountId,
  core.String webPropertyId,
  core.String profileId,
  core.String experimentId, {
  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') +
      '/experiments/' +
      commons.escapeVariable('$experimentId');

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