get method

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

Gets a goal to which the user has access.

Request parameters:

accountId - Account ID to retrieve the goal for.

webPropertyId - Web property ID to retrieve the goal for.

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

goalId - Goal ID to retrieve the goal for.

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

Completes with a Goal.

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

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