list method
Lists Chrome browser profiles of a customer based on the given search and sorting criteria.
Request parameters:
parent
- Required. Format: customers/{customer_id}
Value must have pattern ^customers/\[^/\]+$
.
filter
- Optional. The filter used to filter profiles. The following
fields can be used in the filter: - profile_id - display_name - user_email
- last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state - ouId Any of the above fields can be used to specify a filter, and filtering by multiple fields is supported with AND operator. String type fields and enum type fields support '=' and '!=' operators. The integer type and the timestamp type fields support '=', '!=', '<', '>', '<=' and '>=' operators. Timestamps expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00). Wildcard '*' can be used with a string type field filter. In addition, string literal filtering is also supported, for example, 'ABC' as a filter maps to a filter that checks if any of the filterable string type fields contains 'ABC'. Organization unit number can be used as a filtering criteria here by specifying 'ouId = ${your_org_unit_id}', please note that only single OU ID matching is supported.
orderBy
- Optional. The fields used to specify the ordering of the
results. The supported fields are: - profile_id - display_name -
user_email - last_activity_time - last_policy_sync_time -
last_status_report_time - first_enrollment_time - os_platform_type -
os_version - browser_version - browser_channel - policy_count -
extension_count - identity_provider - affiliation_state By default,
sorting is in ascending order, to specify descending order for a field, a
suffix " desc" should be added to the field name. The default ordering is
the descending order of last_status_report_time.
pageSize
- Optional. The maximum number of profiles to return. The
default page size is 100 if page_size is unspecified, and the maximum page
size allowed is 200.
pageToken
- Optional. The page token used to retrieve a specific page of
the listing request.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleChromeManagementVersionsV1ListChromeBrowserProfilesResponse.
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<GoogleChromeManagementVersionsV1ListChromeBrowserProfilesResponse>
list(
core.String parent, {
core.String? filter,
core.String? orderBy,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (orderBy != null) 'orderBy': [orderBy],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/profiles';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleChromeManagementVersionsV1ListChromeBrowserProfilesResponse
.fromJson(response_ as core.Map<core.String, core.dynamic>);
}