list method
Returns child web data streams under the specified parent property.
Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.
Request parameters:
parent
- Required. The name of the parent property. For example, to list
results of web streams under the property with Id 123: "properties/123"
Value must have pattern ^properties/\[^/\]+$
.
pageSize
- The maximum number of resources to return. If unspecified, at
most 50 resources will be returned. The maximum value is 200; (higher
values will be coerced to the maximum)
pageToken
- A page token, received from a previous ListWebDataStreams
call. Provide this to retrieve the subsequent page. When paginating, all
other parameters provided to ListWebDataStreams
must match the call that
provided the page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse.
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<GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final _queryParams = <core.String, core.List<core.String>>{
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final _url =
'v1alpha/' + core.Uri.encodeFull('$parent') + '/webDataStreams';
final _response = await _requester.request(
_url,
'GET',
queryParams: _queryParams,
);
return GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse.fromJson(
_response as core.Map<core.String, core.dynamic>);
}