list method
List the ad units under the specified AdMob account.
Request parameters:
parent
- Required. Resource name of the account to list ad units for.
Example: accounts/pub-9876543210987654
Value must have pattern ^accounts/\[^/\]+$
.
pageSize
- The maximum number of ad units to return. If unspecified or
0, at most 10,000 ad units will be returned. The maximum value is 20,000;
values above 20,000 will be coerced to 20,000.
pageToken
- The value returned by the last ListAdUnitsResponse
;
indicates that this is a continuation of a prior ListAdUnits
call, and
that the system should return the next page of data.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListAdUnitsResponse.
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<ListAdUnitsResponse> 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_ = 'v1/' + core.Uri.encodeFull('$parent') + '/adUnits';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListAdUnitsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}